Module enthought.mayavi.tools.auto_doc

API Reference for Enthought Tool Suite 3.0.1

Automatic documentation from traited objects.

Variables
Functions
Imported Names

Variables

old_dedent
```
old_dedent = dedent
```

Function summary

dedent(text)
format_argument(trait_name, trait_obj)
make_doc(klass)
traits_doc(traits)

Functions

dedent(text)

Removes as much indentation as possible from some text, but does not modify the first line.
format_argument(trait_name, trait_obj)
make_doc(klass)

Builds a docstring from the object's docstring, and it's traits help.
traits_doc(traits)

Imported Names

Local name	Refers to
dedent	textwrap.dedent
fill	textwrap.fill
types	types
wrap	textwrap.wrap

© Copyright 2002-2008 Enthought, Inc.