smpl_doc.doc

Simplified python code documentation.

Functions

append(txt)

Append txt in the target function docstring.

append_doc(original)

Append doc string of original to target object.

append_str(txt)

Append txt in the target function docstring.

array_table(arr[, top, bottom, init, tabs, ...])

Produces a reST table from a numpy array or normal 2d array.

deprecated([version, deprecated_in, ...])

Decorator to mark a function as deprecated.

dict_to_table(dic)

insert(txt)

Insert txt in the target function docstring.

insert_doc(original)

Inserts the docstring from passed function original in the target function docstring.

insert_str(txt)

Insert txt in the target function docstring.

table(dic[, top, bottom, init, tabs])

Add dict= {'key': [values...]} to a simple reST table.

table_sep([tabs])

trim_eol_spaces(s)

Trim spaces at the end of lines.