Creating a database for world crises similar to what IMDB is for movies that can be navigated in a similar manner. Parsed and accessed through python and initially stored in XML and validated against an XSD. The XML is converted in MySQL later on.
Use pydoc to document the interfaces.
The above documentation only needs to be generated for WCDB3.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.
mduban
commented
11 years ago
Use pydoc to document the interfaces. The above documentation only needs to be generated for WCDB3.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.