-
Notifications
You must be signed in to change notification settings - Fork 0
CritiqueDocumentation
switham edited this page Jan 25, 2014
·
5 revisions
If you're a collaborator on this project, one way to comment on the documentation is to simply edit it in the wiki here. Another is to fork (clone and branch) the wiki repository, edit the docs, and make a pull request.
This page is about suggestions that you are uncertain about, or general comments about the docs that don't amount to edits.
The overview and recommendations-for-use stuff is in Documentation, and of course short, technical docstrings in treeprng.py.
Is the split between the Documentation (verbose and general) and the docstrings (terse and technical) right? Are they actually consistent with each other?