Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inline documentation using Julia 0.4 new doc system #116

Closed
jfsantos opened this issue Oct 12, 2015 · 2 comments
Closed

Inline documentation using Julia 0.4 new doc system #116

jfsantos opened this issue Oct 12, 2015 · 2 comments

Comments

@jfsantos
Copy link
Member

Julia 0.4 has a new documentation system which allows adding inline docs that can be accessed via the REPL. We should make sure all the functions exported by the DSP.jl module have inline docs. They do not need the same level of detail as our online docs, but should at least be slightly useful.

@simonster
Copy link
Member

Yes, this is a good idea. Ideally we'd be able to use the same docs for inline help and the website, but AFAIK there's no general way to do that yet. @shashi has a script here, but it doesn't support sections like our current sphinx/rst docs. We could also try to adapt genstdlib.jl from Base, although that's clearly a bit of a hack.

@jfsantos
Copy link
Member Author

Do you think we should maybe port our current docs to inline docs by hand and then figure out a way of extracting it to rst/md? I could start working on that in a separate branch.

I've seen some people argue that the online docs should be an expanded version of the inline docs, but I don't have a strong opinion on it. I'm inclined to agree in cases where the documentation for each function is huge, includes several references and such, but ours is pretty succinct and should work well for both formats.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants