 utilities |
 contents |
 introduction |
Print help information about a GeodiseLab module or function.
gd_help(target,hidden=1)
This command prints information about any module, function or class in the Jython workspace. The inline documentation of the object is printed, and the contents of the object are formatted and displayed.
gd_help(target) where target is the module, function or class to be displayed. When target is a function the input arguments will be inspected and printed. When target is a module or class the contents of the object will be recursively inspected ("private" functions will not be displayed).
gd_help(target,hidden) when hidden is false all of the functions contained in module and classes will be displayed, otherwise private fuctions (those whose name begin with an underscore) will not be printed.
The function gd_help is available in the modules gdcompute, gddatabase and gdxml.
>>> from gdxml import gd_help, xml_format
>>> gd_help(xml_format)
Help on function xml_format:
NAME
xml_format( V, attswitch='on', name='root' )
DESCRIPTION
Formats the variable V into a name-based tag XML string.
V -- a
string, number, complex, list, tuple, dictionary,
or instance
attswitch -- 'on'- writes attributes, 'off'- writes "plain" XML
name -- give root element a specific name, eg. 'project'
Copyright © 2005, The Geodise Project, University of Southampton