get_full_description¶
- DocstringProcessor.get_full_description(s, base=None)[source]¶
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 theget_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 inbase + '.full_desc'
. Otherwise, it will not be stored at all
- Returns
The extracted full description
- Return type
str