beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Davor Bonaci (JIRA)" <>
Subject [jira] [Resolved] (BEAM-751) infrastructure for extracting code snippets into documentation
Date Mon, 20 Mar 2017 17:26:41 GMT


Davor Bonaci resolved BEAM-751.
       Resolution: Fixed
    Fix Version/s: Not applicable

> infrastructure for extracting code snippets into documentation
> --------------------------------------------------------------
>                 Key: BEAM-751
>                 URL:
>             Project: Beam
>          Issue Type: Improvement
>          Components: website
>            Reporter: Frances Perry
>            Assignee: Robert Bradshaw
>              Labels: starter
>             Fix For: Not applicable
> 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
> * 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

View raw message