This content refers to an unreleased development version of PyMVPA

mvpa.base.dochelpersΒΆ

Various helpers to improve docstrings and textual output

Functions

borrowdoc(cls[, methodname]) Return a decorator to borrow docstring from another cls.`methodname`
borrowkwargs(cls[, methodname, exclude]) Return a decorator which would borrow docstring for **kwargs
enhanced_doc_string(item, *args, **kwargs) Generate enhanced doc strings for various items.
handle_docstring(text[, polite]) Take care of empty and non existing doc strings.
single_or_plural(single, plural, n) Little helper to spit out single or plural version of a word.
table2string(table[, out]) Given list of lists figure out their common widths and print to out

Previous topic

mvpa.base.config.ConfigManager

Next topic

mvpa.base.dochelpers.borrowdoc

NeuroDebian

NITRC-listed