vcshelp

# VCS help module

vcs.vcshelp.help(*arg)[source]

Prints the documentation for named VCS class(es) and/or function(s).

Example
>>> vcs.help('fillareaobject') # show fillarea help
The Fillarea class ...
>>> vcs.help('getboxfill')
VCS ...
Parameters

arg

One or multiple strings containing the name(s) of object(s) and/or function(s) to view the documentation for.

Note

To get help on a VCS object class, you must supply a string that is the name of that class, plus the word “object”. (i.e. vcs.help(“templateobject”) will print the documentation for the template class)

vcs.vcshelp.objecthelp(*arg)[source]

Print the documentation of each object in the argument list. Prints a blank line if no documentation.

Example
>>> fa=vcs.getfillarea()
>>> vcs.objecthelp(fa) # print fillarea class documentation
The Fillarea class ...
Parameters

arg (VCS object, or list of vcs objects) – Instance(s) of VCS object(s) to display the documentation for. Multiple objects should be comma-delimited.