Commenting & documentation

[rob-luke]

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]

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

[jfsantos]

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]

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.

[jfsantos]

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