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

Everything documented in the API reference should have docstrings #525

Open
bgrant opened this issue Jul 16, 2014 · 2 comments
Open

Everything documented in the API reference should have docstrings #525

bgrant opened this issue Jul 16, 2014 · 2 comments
Labels
docs easy
Milestone
wishlist

Comments

@bgrant
Copy link
Contributor

bgrant commented Jul 16, 2014

http://distarray.readthedocs.org/en/latest/distarray.html

If it's in this reference, it should have a docstring, including functions, classes, modules, and packages.

We're not doing too badly on this, but there are some exceptions.
@bgrant bgrant added the docs label Jul 16, 2014
@bgrant bgrant added this to the 0.5 milestone Jul 16, 2014
@bgrant bgrant changed the title All functions documented in the API reference should have docstrings Everything documented in the API reference should have docstrings Jul 17, 2014
@markkness markkness mentioned this issue Jul 17, 2014
Merged
@kwmsmith kwmsmith modified the milestones: 0.5, 0.6, wishlist Aug 8, 2014
@kwmsmith
Copy link
Contributor

kwmsmith commented Aug 8, 2014

This is nice to have, but has to take a back seat to core features.

@bgrant bgrant added the easy label Aug 12, 2014
@bgrant
Copy link
Contributor Author

bgrant commented Aug 12, 2014

This would be an easy place for someone new to get started contributing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs easy
Projects
None yet
Milestone
wishlist
Development

No branches or pull requests
2 participants
@kwmsmith @bgrant