Xiangrui Meng created SPARK-10382:
-------------------------------------
Summary: Make example code in user guide testable
Key: SPARK-10382
URL: https://issues.apache.org/jira/browse/SPARK-10382
Project: Spark
Issue Type: Brainstorming
Components: Documentation, ML, MLlib
Reporter: Xiangrui Meng
Assignee: Xiangrui Meng
Priority: Critical
The example code in the user guide is embedded in the markdown and hence it is
not easy to test. It would be nice to automatically test them. This JIRA is to
discuss options to automate example code testing and see what we can do in
Spark 1.6.
One option I propose is to move actual example code to spark/examples and test
compilation in Jenkins builds. Then in the markdown, we can reference part of
the code to show in the user guide. This requires adding a Jekyll tag that is
similar to
https://github.com/jekyll/jekyll/blob/master/lib/jekyll/tags/include.rb, e.g.,
called include_example.
{code}
{% include_example scala ml.KMeansExample guide %}
{code}
Jekyll will find
`examples/src/main/scala/org/apache/spark/examples/ml/KMeansExample.scala` and
pick code blocks marked "guide" and put them under `{% highlight %}` in the
markdown. We can discuss the syntax for marker comments.
Just one way to implement this. 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
