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

Numpy docstrings #102

Open
davidthomas5412 opened this issue Oct 20, 2016 · 2 comments
Open

Numpy docstrings #102

davidthomas5412 opened this issue Oct 20, 2016 · 2 comments
Assignees

Comments

@davidthomas5412
Copy link
Collaborator

Convert docstrings to numpy docstrings throughout codebase.

https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#class-docstring

@davidthomas5412
Copy link
Collaborator Author

Probably worth keeping a consistent documentation style throughout the main module. Right now there is code from @drphilmarshall around the time of original paper which has one style (lots of commented lines to separate methods etc, a docstring that is not quite numpydocstring style) and code from @sweverett that has a slightly different style (documentation but not quite numpydocstring style). If neither of you have objections I was planning to convert the files with these different styles to the numpydocstring style in a fairly aggressive manner to resolve this issue.

@drphilmarshall
Copy link
Owner

drphilmarshall commented Oct 28, 2016 via email

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