wiki:ClassTemplate

Version 6 (modified by rwilson, 15 years ago) (diff)

--

Internal Documentation/Classes


{name_of_class} Class = Defined in file xyzzy.py.

Discussion

Put a general discussion of the class, it's usage, whatever, here.

{name_of_class} Attributes

attribute name Detailed discussion of attribute
attribute name Detailed discussion of attribute
attribute name Detailed discussion of attribute

{name_of_class} Methods

methodname Detailed discussion of method
methodname Detailed discussion of method
methodname Detailed discussion of method

Notes

Any notes necessary go here. Things like "This class is deprecated/obsolete", etc.


Internal Documentation/Classes