[
https://issues.apache.org/jira/browse/BEAM-751?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15832734#comment-15832734
]
ASF GitHub Bot commented on BEAM-751:
-------------------------------------
GitHub user robertwb opened a pull request:
https://github.com/apache/beam-site/pull/129
[BEAM-751] Extract Python code snippets from tested examples.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/robertwb/incubator-beam-site snippets
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/beam-site/pull/129.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #129
----
commit 0b44ef7770f121558d4008290c49dcd3dd4f8bae
Author: Robert Bradshaw <rober...@gmail.com>
Date: 2017-01-21T01:26:41Z
Add plugin for snippet extraction.
commit b8673ddee75cbdf92067d5787426c0a68a681d02
Author: Robert Bradshaw <rober...@gmail.com>
Date: 2017-01-21T01:55:13Z
Replace literal code samples with extracted, tested snippets.
----
> infrastructure for extracting code snippets into documentation
> --------------------------------------------------------------
>
> Key: BEAM-751
> URL: https://issues.apache.org/jira/browse/BEAM-751
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: Frances Perry
> Assignee: James Malone
> Labels: starter
>
> As we fill in more and more documentation, the number of code snippets is
> going to drastically increase, and we should ensure the quality of those
> snippets by automatically extracting them from code that is regularly
> compiled and tested.
> Goals:
> * automatically extract code snippets from incubator-beam for use in the beam
> website documentation
> * use stable references so folks editing the code can clearly tell what
> documentation changes this will result in (good: specially formatted comment,
> bad: line number)
> * freshness (is live possible? or at least during the general 'jekyll build'
> phase?)
> The best we've found so far is using jekyll-gist with gist-it, but that would
> rely on fragile line numbers.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
