Skip to content
This repository has been archived by the owner on Feb 6, 2024. It is now read-only.

Commenting & documentation #6

Closed
rob-luke opened this issue Nov 24, 2014 · 4 comments
Closed

Commenting & documentation #6

rob-luke opened this issue Nov 24, 2014 · 4 comments

Comments

@rob-luke
Copy link
Member

Im soon to upload an APES spectral estimator to the estimation package.
But I had some questions about commenting and documentation first.

Is there was a standard julia practice for commenting within code?
I see quite a variety of styles within the DSP organisation.

Also I have been using Docile.jl to keep my documentation and comments organised.
DSP uses readthedocs, wavelets seems hand written, and estimation uses nothing.
Should I use a particular system to minimise upkeep of these packages?

@gummif
Copy link
Member

gummif commented Nov 24, 2014

I'm personally waiting for the standard documentation system, see
JuliaLang/julia#8791
JuliaLang/julia#8966

@jfsantos
Copy link
Member

That's exactly what I was going to say. Many packages (like DSP) currently use Sphinx and host the documentation at readthedocs, but I think we should move to the standard documentation system later (at least for inline documentation at first, and then I am sure somebody will come up with an inline-to-Readthedocs-friendly converter in a snap).

@rob-luke
Copy link
Member Author

rob-luke commented Dec 9, 2014

Thanks for the feedback.
I used Docile for the estimation package, and will adjust the code as required when the standard documentation system goes online.

@rob-luke rob-luke closed this as completed Dec 9, 2014
@jfsantos
Copy link
Member

jfsantos commented Dec 9, 2014

Great. Docile looks a lot like the new doc system, so the transition will probably be easy.

mpastell referenced this issue in mpastell/DSP.jl Dec 30, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants