type Desc_container

A special object for holding and processing user function description information.

Instance Methods

__init__(self, title='Description')
Set up the container.

add_item_list_element(self, item, text)
Add the element of an itemised list to the description.

add_list_element(self, text)
Add the element of a list to the description.

add_paragraph(self, text)
Add a paragraph of text to the description.

add_prompt(self, text)
Add the text of a relax prompt example to the description.

add_table(self, label)
Add a table to the description.

add_verbatim(self, text)
Add a section of verbatim text to the description.

str and anything element_loop(self, title=False)
Iterator method yielding the description elements.

str get_title(self)
Return the title of the section.

Method Details

__init__(self, title='Description')
(Constructor)

Set up the container.

Parameters:

• section (str) - The section title.

Overrides: object.__init__

add_item_list_element(self, item, text)

Add the element of an itemised list to the description.

Parameters:

• item (str) - The item text.
• text (str) - The itemised list element text.

add_list_element(self, text)

Add the element of a list to the description.

Parameters:

• text (str) - The list element text.

add_paragraph(self, text)

Add a paragraph of text to the description.

Parameters:

• text (str) - The paragraph text.

add_prompt(self, text)

Add the text of a relax prompt example to the description.

Parameters:

• text (str) - The relax prompt text.

add_table(self, label)

Add a table to the description.

Parameters:

• label (str) - The unique label corresponding to a user_functions.objects.Table instance.

add_verbatim(self, text)

Add a section of verbatim text to the description.

Parameters:

• text (str) - The verbatim text.

element_loop(self, title=False)

Iterator method yielding the description elements.

Parameters:

• title (bool) - A flag which if True will cause the title to be yielded first.

Returns: str and anything

The element type and corresponding data.

get_title(self)

Return the title of the section.

Returns: str

The section title.