Wonderful job!  Been waiting for this since JuliaCon!

On Sunday, August 2, 2015 at 3:22:03 PM UTC-4, Mike Innes wrote:
>
> Hi All,
>
> As of #11943 <https://github.com/JuliaLang/julia/pull/11943>, Julia uses 
> the shiny new doc system to provide help for functions in the REPL. 
> Previously, docstrings were stored in ReStructured text files 
> <https://github.com/JuliaLang/julia/tree/master/doc/stdlib> as part of 
> the manual, but now all docstrings are kept in Base 
> <https://github.com/JuliaLang/julia/blob/master/base/docs/helpdb.jl> and 
> the rst docs are automatically generated.
>
> What this means immediately is that any updates to Base docstrings must 
> happen in the helpdb.jl file 
> <https://github.com/JuliaLang/julia/blob/master/base/docs/helpdb.jl>, as 
> opposed to the RST docs. Note that it's still fine to edit the main body of 
> the manual; only function docstrings, which can be identified by the `.. 
> function::` syntax, are affected by this change.
>
> Right now everything is in one big file, but we'd like to move the 
> docstrings to appropriate places in Base and convert them to Markdown. 
> We'll need some help with that, as there are a *lot* of docstrings, but 
> when we're ready we'll send out a call for help so that people can get 
> involved.
>
> There's still a lot of work to do, but I think this will be a big step 
> forward for documentation in Julia.
>
> – Mike
>

Reply via email to