agrover/rtslib-fb — Issue #11: add return types to epydoc docstrings
Author: JonnyJD
Created: 2012-03-09 15:45:55+00:00
State: open

Working on the session API I realized, that most properties and functions don't list a return type.
The format is ```@return: description``` and ```@rtype: type``` for functions and ```@type: type``` for properties (and instance variables). This is especially helpful because we can even link the types: ```L{NodeACL}```.

[epydoc](http://epydoc.sourceforge.net/) is already used and there is also an [old documentation](http://www.risingtidesystems.com/doc/rtslib/html/) online. There is a lot of epydoc-specific parameter documentation in the docstrings of functions, but somehow return types are missing.

I documented my session branch (JonnyJD/rtslib-fb@d95ecc6ecd3eab4c0803364ec225829bdf5f20bb) additions.

I note that we don't really have to document private functions and variables this way.