Package mvpa :: Package base :: Module dochelpers
[hide private]
[frames] | no frames]

Module dochelpers

source code

Functions [hide private]
 
rstUnderline(text, markup)
Add and underline RsT string matching the length of the given string.
source code
 
handleDocString(text)
Take care of empty and non existing doc strings.
source code
 
enhancedDocString(name, lcl, *args)
Generate enhanced doc strings.
source code
 
enhancedClassDocString(cls, *args)
Generate enhanced doc strings but given a class, not just a name.
source code
 
table2string(table, out=None)
Given list of lists figure out their common widths and print to out
source code

Imports: re, textwrap, N, ceil, StringIO


Function Details [hide private]

enhancedClassDocString(cls, *args)

source code 

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

table2string(table, out=None)

source code 
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
Returns:
string if out was None