[jira] [Commented] (SPARK-10383) Sync example code between API doc and user guide

["Joseph K. Bradley (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SPARK-10383?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15081806#comment-15081806 ] 

Joseph K. Bradley commented on SPARK-10383:
-------------------------------------------

This can be closed now, right?

> Sync example code between API doc and user guide
> ------------------------------------------------
>
>                 Key: SPARK-10383
>                 URL: https://issues.apache.org/jira/browse/SPARK-10383
>             Project: Spark
>          Issue Type: Brainstorming
>          Components: Documentation, ML, MLlib
>            Reporter: Xiangrui Meng
>            Assignee: Xiangrui Meng
>
> It would be nice to provide example code in both user guide and API docs. However, it would become hard to keep the content in-sync. This JIRA is to collect approaches/processes to make it feasible.
> This is related to SPARK-10382, where we discuss how to move example code from user guide markdown to `spark/examples/`. After that, we can look for solutions that can pick up example code from `spark/examples` and make them available in the API doc. Though I don't know any feasible solution right now, those are some relevant projects:
> * https://github.com/tkawachi/sbt-doctest
> * http://www.doctester.org/
> It would be nice to hear more ideas.



--
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