PyroDocFormat

1. pyro.module.Classname

Class Docstring.

In File: pyrobot/module/classname/init.py

Subclass of: pyro.module.Superclass (see PyroDocModuleSuperclass) in pyrobot/module/superclass.py

Depends on:

• List imports and external class/function calls here,

• especially ones which in Pyro which might be changed in the future.

Comments

1. pyro.module.Classname
1. Public Data Members
2. Constructor(Arg1, Arg2 = 2)
3. Internal Functions
1. _foo()
4. External Functions
1. Bar(Arg1, Arg2)

1.1. Public Data Members

• foo: Constant; helpful for something

• data: use this for data

Comments

1.2. Constructor(Arg1, Arg2 = 2)

Constructor Docstring

Arguments:

• Arg1: Number of foos in a bar.

• Arg2: [Optional, def. 2] Some setting.

Comments

1.3. Internal Functions

1.3.1. _foo()

Function Docstring

Comments

1.4. External Functions

1.4.1. Bar(Arg1, Arg2)

Function Docstring

Arguments:

• Arg1: ...

• Arg2: ...

• [Keyword]Arg3: ... Etc.

Returns:

Return value

Comments

Immutable page (last edited 2007-03-26 22:19:13 by QuincyPlumer)

Or try one of these actions: LikePages, LocalSiteMap, SpellCheck