Multivariate Pattern Analysis in Python

### Navigation

- index
- modules |
- modules |
- PyMVPA Home |
- Sitemap »

# mvpa2.base.dochelpers

Various helpers to improve docstrings and textual output

Functions

`borrowdoc`(cls[, methodname]) | Return a decorator to borrow docstring from another `cls`.`methodname` It should not be used for __init__ methods of classes derived from ClassWithCollections since __doc__’s of those are handled by the AttributeCollector anyways.
`borrowkwargs`(cls[, methodname, exclude]) | Return a decorator which would borrow docstring for `**kwargs` :Parameters: methodname : None or str Name of the method from which to borrow.
`ceil`(x) | Return the ceiling of x as a float.
`enhanced_doc_string`(item, *args, **kwargs) | Generate enhanced doc strings for various items.
`exists`(dep[, force, raise_, issueWarning]) | Test whether a known dependency is installed on the system.
`get_docstring_split`(f) | Given a function, break it up into portions
`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 :Parameters: table : list of lists of strings What is aimed to be printed out : None or stream Where to print.

Classes

`StringIO`([buf]) | class StringIO([buffer])

### Navigation

- index
- modules |
- modules |
- PyMVPA Home |
- Sitemap »