You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Feynman Liang (JIRA)" <ji...@apache.org> on 2015/08/17 20:05:45 UTC
[jira] [Created] (SPARK-10062) Use tut for typechecking and running
code in user guides
Feynman Liang created SPARK-10062:
-------------------------------------
Summary: Use tut for typechecking and running code in user guides
Key: SPARK-10062
URL: https://issues.apache.org/jira/browse/SPARK-10062
Project: Spark
Issue Type: Improvement
Components: Documentation
Reporter: Feynman Liang
The current process for contributing to the user guide requires authors/reviewers to manually run any added example code.
We can automate this process by integrating [tut|https://github.com/tpolecat/tut] into user guide documentation generation. Tut runs code enclosed inside "```tut ... ```" blocks, providing typechecking, ensuring that the example code we provide runs, and displaying the output.
--
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