spark-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Xiangrui Meng (JIRA)" <>
Subject [jira] [Commented] (SPARK-11337) Make example code in user guide testable
Date Tue, 26 Jan 2016 20:42:39 GMT


Xiangrui Meng commented on SPARK-11337:

[~yinxusen] Could you make a pass over current user guide and see whether we have more example
code to migrate over?

> Make example code in user guide testable
> ----------------------------------------
>                 Key: SPARK-11337
>                 URL:
>             Project: Spark
>          Issue Type: Umbrella
>          Components: Documentation
>            Reporter: Xiangrui Meng
>            Assignee: Xusen Yin
>            Priority: Critical
>             Fix For: 1.6.0
> 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,
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 "example" and put them under `{% highlight %}` in the markdown.
We can discuss the syntax for marker comments.
> Sub-tasks are created to move example code from user guide to `examples/`.

This message was sent by Atlassian JIRA

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message