Skip to content

Documentation needs more examples #2

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
Open
thesketh opened this issue Mar 2, 2020 · 1 comment
Open

Documentation needs more examples #2

thesketh opened this issue Mar 2, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@thesketh
Copy link
Owner

thesketh commented Mar 2, 2020

At present, the ReadTheDocs documentation is somewhat limited. It contains the function/class signatures, but no examples of using the code.

There are examples in the README which cover the most basic use, but these could be expanded upon for more complex examples.
@thesketh thesketh added the documentation Improvements or additions to documentation label Mar 2, 2020
@thesketh thesketh added this to the 0.2.3 milestone Mar 2, 2020
@RMeli RMeli mentioned this issue Mar 10, 2020
Closed
57 tasks
@thesketh
Copy link
Owner Author

More examples added for command line usage in 79b3265, still need to add examples for library usage. Examples need to be added to RtD documentation.

@thesketh thesketh removed this from the v0.2.3 milestone Mar 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@thesketh