An Alternative Python Reference: Sections

Fredrik Lundh | January 2006

(This page belongs to the Alternative Python Reference project.)

@@module

Specifies what module this source file describes. Each source file should describe exactly one module. By convention, this section marker should be placed first in the file.

@@function

Syntax: @@function name

Defines a function in this module.

@@variable

Syntax: @@variable name

Defines a variable in this module.

@@class

Syntax: @@class name

Defines a class in this module.

@@method

Syntax: @@method classname.name

Defines a method (or other callable attribute) in the given class.

@@attribute

Syntax: @@attribute classname.name

Defines an attribute (or other property) in the given class.

@@exception

Syntax: @@exception name

Defines an exception in this module.

@@section

Syntax: @@section title

Ends the current section, and opens a new section (H2).

@@subsection

Syntax: @@subsection title

Ends the current section, and opens a new subsection (H3).

@@text

Syntax: @@text

Ends the current section, and opens a new plain text section.