ba08fcb69290d8fd4817eed850e43e5ff0b5ecd5 kate Wed Feb 23 11:04:04 2011 -0800 Add doc convention diff --git python/ucscgenomics/style.txt python/ucscgenomics/style.txt index 761b52f..0b958e7 100644 --- python/ucscgenomics/style.txt +++ python/ucscgenomics/style.txt @@ -1,23 +1,28 @@ Style Guide for Python Code +Documentation Conventions + +Use ''' doc strings to embed comments for automated documentation generator: + http://epydoc.sourceforge.net/ + Naming Conventions Packages and Modules All lowercase names, no spaces. Underscores if it would improve readability in modules, but not for use in packages. Classes CapitalCase names. Note the leading captial letter to distinguish between a ClassName and a functionName. Underscores are not used, except for private internal classes. Functions mixedCase names. The leading character is not captialized, but all successive words are capitalized. Underscores are not used. Variables mixedCase names. Underscores are not to be used. Constants ALL_CAPS_WITH_UNDERSCORE used for names. No lowercase or leading underscores.