[SPARK-6626] TwitterUtils.createStream documentation error

• Type: Documentation
• Status: Resolved
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 1.3.0
• Fix Version/s: 1.3.1, 1.4.0
• Component/s: Documentation
• Labels: documentation easyfix
• Assignee: Jayson Sunshine
• Reporter: Jayson Sunshine
• Created: 31/Mar/15 05:40
• Updated: 01/Apr/15 10:14
• Resolved: 01/Apr/15 10:14

Description

At http://spark.apache.org/docs/1.3.0/streaming-programming-guide.html#input-dstreams-and-receivers, under 'Advanced Sources', the documentation provides the following call for Scala:

TwitterUtils.createStream(ssc)

However, with only one parameter to this method it appears a jssc object is required, not a ssc object: http://spark.apache.org/docs/1.3.0/api/java/index.html?org/apache/spark/streaming/twitter/TwitterUtils.html

To make the above call work one must instead provide an option argument, for example:

TwitterUtils.createStream(ssc, None)

Issue Links

• links to: [Github] Pull Request #5295 (JaysonSunshine)