parseDef

emlib.doctools.parseDef(obj)[source]

Parses a function/method, analyzing the signature / docstring.

Note

For a class, use generateDocsForClass

Parameters:

obj – the object to parse

Return type:

ParsedDef

Returns:

a ParsedDef

Raises:

ParseError if func cannot be parsed –