get_full_description

Docorator.get_full_description(s, base=None)

Get the full description from a docstring.

This here and the line above is the full description (i.e. the combination of the get_summary() and the get_extended_summary()) output

Parameters
  • s (str) – The docstring to use

  • base (str or None) – A key under which the description shall be stored in the params attribute. If not None, the summary will be stored in base + '.full_desc'. Otherwise, it will not be stored at all

Returns

The extracted full description

Return type

str