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

add documentation/ follow google style guide #19

Open

maxnoe opened this issue Jan 31, 2015 · 1 comment

Labels

Milestone

Collaborator

maxnoe commented Jan 31, 2015

We need to add more documentation, docstrings for all classes etc.

The google style guide might be helpful:
http://google-styleguide.googlecode.com/svn/trunk/pyguide.html

maxnoe added the enhancement label

Owner

ibab commented Jan 31, 2015

I prefer the numpy style of documentation: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

ibab modified the milestone: v0.1

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