This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Functions and Methods (function or method docstrings) | |
@param p: ... A description of the parameter p for a function or method. It may appear in the class docstring to describe a costructor parameter: mostly useful for C extensions. | |
@type p: ... The expected type for the parameter. p. | |
@return: ... The return value for a function or method. | |
@rtype: ... The type of the return value for a function or method. | |
@keyword p: ... A description of the keyword parameter p. It may appear in the class docstring to describe a costructor keyword parameter. | |
@raise e: ... A description of the circumstances under which a function or method raises exception e. It may appear in the class docstring to describe an exception that can be raised by the costructor. | |
Variables (module, class or variable docstrings) |