Trees       Indices       Help   
Module coding_style :: Class CodingStyle
[hide private]
[frames] | no frames]

Class CodingStyle

source code

A docstring describing the class should be included for every class.

Details for plans with the class and information for adapting it should also go into the docstring.

A docstring should be seperated from the following code by at least one empty line to lessen confusion.

Instance Methods [hide private]
  __init__(self, style="style")
Every function needs a docstring, too.
  __repr__(self)
Information about the class which is intended to be seen by a user of the program, not by a developer.

Instance Variables [hide private]
  style
The coding style.

Method Details [hide private]

__init__(self, style="style")
(Constructor)

source code 

Every function needs a docstring, too.

Additional lines should contain special cases and any quirks which might not behave exactly as expected.

__repr__(self)
(Representation operator)

source code 
Information about the class which is intended to be seen by a user of the program, not by a developer. Print it, if it's intended for command line useage, else return it as string.

Instance Variable Details [hide private]

style

The coding style. Every variable needs a description in epydoc format.

   Trees       Indices       Help   
Generated by Epydoc 3.0alpha3 on Sun Oct 28 23:11:30 2007 http://epydoc.sourceforge.net