get_summary

Docorator.get_summary(s, base=None)

Get the summary of the given docstring.

This method extracts the summary from the given docstring s which is basicly the part until two newlines appear

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'. Otherwise, it will not be stored at all

Returns

The extracted summary

Return type

str