Table Of Contents

Previous topic

mvpa.base.config

Next topic

mvpa.base.externals

This Page

Quick search

mvpa.base.dochelpers

The comprehensive API documentation for this module, including all technical details, is available in the Epydoc-generated API reference for mvpa.base.dochelpers (for developers).

Functions

mvpa.base.dochelpers.enhancedClassDocString(cls, *args)

Generate enhanced doc strings but given a class, not just a name.

It is to be used from a collector, ie whenever class is already created

See also

Full API documentation of enhancedClassDocString() in module mvpa.base.dochelpers.

mvpa.base.dochelpers.enhancedDocString(name, lcl, *args)
Generate enhanced doc strings.

See also

Full API documentation of enhancedDocString() in module mvpa.base.dochelpers.

mvpa.base.dochelpers.handleDocString(text)
Take care of empty and non existing doc strings.

See also

Full API documentation of handleDocString() in module mvpa.base.dochelpers.

mvpa.base.dochelpers.rstUnderline(text, markup)
Add and underline RsT string matching the length of the given string.

See also

Full API documentation of rstUnderline() in module mvpa.base.dochelpers.

mvpa.base.dochelpers.table2string(table, out=None)

Given list of lists figure out their common widths and print to out

Parameters:
  • table (list of lists of strings) – What is aimed to be printed
  • out (None or stream) – Where to print. If None – will print and return string
Return type:

string if out was None

See also

Full API documentation of table2string() in module mvpa.base.dochelpers.