This repository has been archived by the owner on Feb 6, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commenting & documentation #6
Comments
I'm personally waiting for the standard documentation system, see |
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). |
Thanks for the feedback. |
Great. Docile looks a lot like the new doc system, so the transition will probably be easy. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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?
The text was updated successfully, but these errors were encountered: