Module uf_docstring
source code
The base class for all the user function classes.
|
status = Status()
|
|
uf_tables = Uf_tables()
|
Imports:
deepcopy,
split,
wrap,
ansi,
help,
strip_lead,
Status,
Uf_tables
Convert the text to bold.
This is for use in the help system.
- Parameters:
text (str) - The text to make bold.
- Returns: str
- The bold text.
|
build_subtitle(text,
bold=True,
start_nl=True)
| source code
|
Create the formatted subtitle string.
- Parameters:
text (str) - The name of the subtitle.
bold (bool) - A flag which if true will return bold text. Otherwise an
underlined title will be returned.
start_nl (bool) - A flag which if True will add a newline to the start of the text.
- Returns: str
- The formatted subtitle.
|
Format and return the table as text.
- Parameters:
label (str) - The unique table label.
- Returns: str
- The formatted table.
|
Format the line of text by wrapping.
- Parameters:
text (str) - The line of text to wrap.
- Returns: str
- The wrapped text.
|
table_line(text=None,
widths=None,
bottom=False)
| source code
|
Format a line of a table.
- Parameters:
text (list of str or None) - The list of table elements. If not given, an empty line will be
be produced.
widths (list of int) - The list of column widths for the table.
botton - A flag which if True will cause a table bottom line to be
produced.
bottom (bool)
- Returns: str
- The table line.
|