My favorites | Sign in
Project Home Wiki Issues Source
READ-ONLY: This project has been archived. For more information see this post.
Search
for
  Advanced search   Search tips   Subscriptions
Issue 6: Documentation
1 person starred this issue and may be notified of changes. Back to list
Status:  Done
Owner:  J.Wes.Pickens
Closed:  Feb 2012


 
Project Member Reported by J.Wes.Pickens, Feb 12, 2012
Use pydoc to document the interfaces.
The above documentation only needs to be generated from PFD.py.
Comment each function meaningfully.
Use comments only if you need to explain the why of a particular implementation.
Choose a coding convention and be consistent.
Use good variable names.
Write readable code with good indentation, blank lines, and blank spaces. 
Feb 14, 2012
Project Member #1 J.Wes.Pickens
(No comment was entered for this change.)
Status: Done

Powered by Google Project Hosting