[ https://issues.apache.org/jira/browse/SPARK-10383?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15085167#comment-15085167 ]
Xusen Yin commented on SPARK-10383: ----------------------------------- I think we only (almost) finished the step 1 - moving example codes to spark/examples. There is also a step 2 - connecting spark/examples with API doc according to the introduction of the JIRA. However, I am not quite understanding [~mengxr]'s idea. > 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-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org