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

Improve docs about documenting Julia #18841

Closed
kshyatt opened this issue Oct 7, 2016 · 7 comments
Closed

Improve docs about documenting Julia #18841

kshyatt opened this issue Oct 7, 2016 · 7 comments
Labels
docs This change adds or pertains to documentation docsystem The documentation building system good first issue Indicates a good issue for first-time contributors to Julia Hacktoberfest Good for Hacktoberfest participants

Comments

@kshyatt
Copy link
Contributor

kshyatt commented Oct 7, 2016

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 go grep hunting.

@kshyatt kshyatt added docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia docsystem The documentation building system Hacktoberfest Good for Hacktoberfest participants labels Oct 7, 2016
@akaysh
Copy link
Contributor

akaysh commented Jan 3, 2017

@kshyatt I can help in improving documentation. Can this still be worked on?

@kshyatt
Copy link
Contributor Author

kshyatt commented Jan 3, 2017

Yes! Docs always need improvements!

I think my statement about @eval still applies. Other things that could use with being documented (without reproducing all the Documenter docs...) are more examples of how to doc.

@mauro3
Copy link
Contributor

mauro3 commented Jan 19, 2017

JuliaIO/FileIO.jl#97 (comment):
"Doesn't look like the :: syntax for ? mode is documented currently, probably worth adding that somewhere in the manual."

@ayushi19031
Copy link

@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.

@suryaanshah
Copy link

@kshyatt The link that you have provided, "docs about docs" isn't working now. Is this issue still being worked upon?

@fredrikekre
Copy link
Member

I updated the link.

@ViralBShah
Copy link
Member

I think these are pretty good now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation docsystem The documentation building system good first issue Indicates a good issue for first-time contributors to Julia Hacktoberfest Good for Hacktoberfest participants
Projects
None yet
Development

No branches or pull requests

7 participants