[jira] [Resolved] (SPARK-1666) document examples

["Sean Owen (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SPARK-1666?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Sean Owen resolved SPARK-1666.
------------------------------
    Resolution: Done

The examples have been broadly improved, including compiling the test code. I don't know if it specifically addressed this issue, but given how old this is I'm going to call this somewhere between "done" and "wont fix".

> document examples
> -----------------
>
>                 Key: SPARK-1666
>                 URL: https://issues.apache.org/jira/browse/SPARK-1666
>             Project: Spark
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9.1
>            Reporter: Diana Carroll
>
> It would be great if there were some guidance about what the example code shipped with Spark (under $SPARKHOME/examples and $SPARKHOME/python/examples) does and how to run it.  Perhaps a comment block at the beginning explaining what the code accomplishes and what parameters it takes.  Also, if there are sample datasets on which the example is designed to run, please point to those.  
> (As an example, look at kmeans.py, which takes a file argument, but has no hint about what sort of data is in the file or what format the data should be in.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org