-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Improve docs about documenting Julia #18841
Comments
@kshyatt I can help in improving documentation. Can this still be worked on? |
Yes! Docs always need improvements! I think my statement about |
JuliaIO/FileIO.jl#97 (comment): |
@kshyatt I would like to work on this issue. Julia is my first Open source organization I will contribute to, so it will be nice if you could give me tips and suggest more stuff I can start working on. |
@kshyatt The link that you have provided, "docs about docs" isn't working now. Is this issue still being worked upon? |
I updated the link. |
I think these are pretty good now. |
The docs about docs are pretty good but some things, like how to doc
@eval
-ed functions, could really use some examples (writing doctests for this would probably be really hard). There are a couple of examples of what to do scattered throughout the Julia codebase if you gogrep
hunting.The text was updated successfully, but these errors were encountered: