get_extended_summary

DocstringProcessor.get_extended_summary(s, base=None)[source]

Get the extended summary from a docstring.

This here is the extended summary

Parameters

  • s (str) – The docstring to use

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

Returns

The extracted extended summary

Return type

str