type Table

A special class defining the tables used in the user function descriptions.

Instance Methods

__init__(self, label=None, caption=None, caption_short=None, spacing=True, longtable=False)
Set up the table container.

add_headings(self, headings)
Add a row of table headings.

add_row(self, row)
Add a table row.

Method Details

__init__(self, label=None, caption=None, caption_short=None, spacing=True, longtable=False)
(Constructor)

Set up the table container.

Parameters:

• label (str) - The unique label of the table. This is used to identify tables, and is also used in the table referencing in the LaTeX compilation of the user manual.
• caption (str) - The caption for the table.
• caption_short (str) - The optional short caption for the table, used in the LaTeX user manual list of tables section for example.
• spacing (bool) - A flag which if True will cause empty rows to be placed between elements.
• longtable (bool) - A special LaTeX flag which if True will cause the longtables package to be used to spread a table across multiple pages. This should only be used for tables that do not fit on a single page.

Overrides: object.__init__

add_headings(self, headings)

Add a row of table headings.

Parameters:

• headings (list of str) - The table headings.

add_row(self, row)

Add a table row.

Parameters:

• row (list of str) - The table row.