Formatting Standards

Formatting Standards

 Naming Conventions:
     - class names use camelCase with an initial capitilization: ClassName
     - publicly relevant attributes use camelCase:  self.someThing
     - local variables and method args use underscores:  some_thing
     - function names use underscores (enforced by PEP8): some_method

 Itemization:
    attributes are itemized without a marker
    - arguments are itemized with dashes
    + parameters (in dicts) are itemized with pluses
    - methods are itemized with bullets
    * notes are itemized with asterisks

 Module organization:
    Imports
    Keywords
    Constants & Structures
    PrefenceSet
    Registry
    Log
    Error
    Variables
    Factory method
    Class definition

 Documentation:
     Description
     [Subclasses]
     Instantiation
     Initialization arguments:
         - variable (<type>): <description>
         - params (<type>): <description>
             + kw<RemainderOfParamName> (type): <description>
         - name (<type>): <description>
         - prefs (<type>): <description>
         - context (<type>): <description>
     <Class>Registry:
     Naming
     Execution
     Class attributes (implemented at clas level)
     Class methods (implemented at class level)
     Instance attributes (implemented in __init__():
     Instance methods (implemented under class)