Re: [julia-users] Re: PSA: Changes to Base Docstrings

[Mike Innes]

Hey all,

Really good to see the enthusiasm about this change. If you're interested
in helping out with the final parts of the transition, head on over to
https://github.com/JuliaLang/julia/pull/12703

– Mike

On Sat, 8 Aug 2015 at 13:36 Joshua Adelman  wrote:

> Public service announcement. It's actually on that Wikipedia page under
> the "other" section:
> https://en.m.wikipedia.org/wiki/Public_service_announcement
>
> Josh
>
> On Aug 8, 2015, at 8:15 AM, Uwe Fechner  wrote:
>
> Hello,
> what does PSA in the title mean?
>
> Wikipedia didn't help: https://en.wikipedia.org/wiki/Psa
>
> Uwe
>
> Am Sonntag, 2. August 2015 21:22:03 UTC+2 schrieb Mike Innes:
>>
>> Hi All,
>>
>> As of #11943 , Julia uses
>> the shiny new doc system to provide help for functions in the REPL.
>> Previously, docstrings were stored in ReStructured text files
>>  as part of
>> the manual, but now all docstrings are kept in Base
>>  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
>> , 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
>>
>

Re: [julia-users] Re: PSA: Changes to Base Docstrings

[Joshua Adelman]

Public service announcement. It's actually on that Wikipedia page under the
"other" section:
https://en.m.wikipedia.org/wiki/Public_service_announcement

Josh

On Aug 8, 2015, at 8:15 AM, Uwe Fechner  wrote:

Hello,
what does PSA in the title mean?

Wikipedia didn't help: https://en.wikipedia.org/wiki/Psa

Uwe

Am Sonntag, 2. August 2015 21:22:03 UTC+2 schrieb Mike Innes:
>
> Hi All,
>
> As of #11943 , Julia uses
> the shiny new doc system to provide help for functions in the REPL.
> Previously, docstrings were stored in ReStructured text files
>  as part of
> the manual, but now all docstrings are kept in Base
>  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
> , 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
>

[julia-users] Re: PSA: Changes to Base Docstrings

[Uwe Fechner]

Hello,
what does PSA in the title mean?

Wikipedia didn't help: https://en.wikipedia.org/wiki/Psa

Uwe

Am Sonntag, 2. August 2015 21:22:03 UTC+2 schrieb Mike Innes:
>
> Hi All,
>
> As of #11943 , Julia uses 
> the shiny new doc system to provide help for functions in the REPL. 
> Previously, docstrings were stored in ReStructured text files 
>  as part of 
> the manual, but now all docstrings are kept in Base 
>  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 
> , 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
>

[julia-users] Re: PSA: Changes to Base Docstrings

[felipenoris]

I would be glad to help with this process.
>
> Will you put a roadmap on what´s needed 
on https://github.com/JuliaLang/julia/issues/12489 ?

[julia-users] Re: PSA: Changes to Base Docstrings

[Ismael VC]

This is great, thank you very much!

El domingo, 2 de agosto de 2015, 14:22:03 (UTC-5), Mike Innes escribió:
>
> Hi All,
>
> As of #11943 , Julia uses 
> the shiny new doc system to provide help for functions in the REPL. 
> Previously, docstrings were stored in ReStructured text files 
>  as part of 
> the manual, but now all docstrings are kept in Base 
>  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 
> , 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
>

[julia-users] Re: PSA: Changes to Base Docstrings

[Scott Jones]

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 , Julia uses 
> the shiny new doc system to provide help for functions in the REPL. 
> Previously, docstrings were stored in ReStructured text files 
>  as part of 
> the manual, but now all docstrings are kept in Base 
>  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 
> , 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
>