Better documentation needed: Expand the docstring documentation.

[klinger]

We have good documentation - but we also have lots of classes and functions without any docstring documentation. About docstring documentation see https://www.python.org/dev/peps/pep-0257/

Why this is important:

• We want to refactor a lot of code, especially concerning the new user interface.. Without documentation its very difficult to refactor.
• We are an international team working on the whole codebase in a semi-chaotic way - everyone may work on any part of the code. Documentation helps a lot.
• Its easier to easer to reuse code if you exactly know what it does.

[leodabbler]

Strictly agree, would help me as well.

[ghost]

I started to write and extend docstrings in a branch docstring as I am learning django and using vp as a reference. Tell me if they are of help or what to change.

[klinger]

Hello @dixmartin
i didnt see a commit in your github doctring branch yet. https://github.com/dixmartin/volunteer_planner/commits/docstrings - but PEP8 docstring documentation is always useful. Please continue!

If you have documentation just commit and make a pull request - as long as you dont change functionality its safe to merge to develop branch: release early, release often! Would help me to understand the code too!

[ghost]

Allright I made a pull request #353.