[
https://issues.apache.org/jira/browse/SPARK-10062?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Feynman Liang updated SPARK-10062:
----------------------------------
Description:
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.
An example project using tuts is [cats|http://non.github.io/cats/].
was:
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.
> 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.
> An example project using tuts is [cats|http://non.github.io/cats/].
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
