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

Add docstring requirements to contribution guidelines #729

Closed
meatballs opened this issue Sep 28, 2016 · 1 comment
Closed

Add docstring requirements to contribution guidelines #729

meatballs opened this issue Sep 28, 2016 · 1 comment

Comments

@meatballs
Copy link
Member

One comment at the PyCon UK sprint was that it's not clear from our guidelines that we expect numpy style docstrings for methods and functions.

We do have #347 to clean up our existing codebase, but we've not been explicit in our expectations for new code.

@drvinceknight
Copy link
Member

👍 (Just an FYI for whoever works on this, the numpy guideline does not extend to strategies for which numpy style ---- etc under section headings breaks the autodoc as it conflicts with the rst syntax).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants