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.

Sign up for GitHub

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

Jump to bottom

Would be nice to have rudimentary documentation #4

Closed
ViralBShah opened this issue Jun 20, 2013 · 5 comments
Closed

Would be nice to have rudimentary documentation #4

ViralBShah opened this issue Jun 20, 2013 · 5 comments

Comments

@ViralBShah
Copy link
Contributor

Would be nice to have some documentation, and examples in README.md so that one can get started with some simple stuff. I am currently looking at the tests to see how to use this package.
@ViralBShah
Copy link
Contributor Author

Also, the installation instructions in the README could be updated to say Pkg.add(), now that it is listed in the packages.

@autozimu
Copy link
Collaborator

Installation has been updated.

@autozimu
Copy link
Collaborator

autozimu commented Jul 3, 2013

Is there any recommended ways to document a Julia package?

@ViralBShah
Copy link
Contributor Author

You can look at the manual in the julia source and adopt JuliaDoc.

@stevengj
Copy link
Member

stevengj commented Aug 8, 2013

The README has been updated for the new version, but the usage is basically the same as matplotlib.pyplot and it doesn't make sense to try to reproduce their voluminous documentation here.

@stevengj stevengj closed this as completed Aug 8, 2013
@few few mentioned this issue Dec 2, 2014
Closed
@ChrisNabold ChrisNabold mentioned this issue Nov 11, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ViralBShah @autozimu @stevengj