papyri
{ } Raw JSON

bundles / scipy 1.17.1 / scipy / _lib / doccer / extend_notes_in_docstring

function

scipy._lib.doccer:extend_notes_in_docstring

source: /scipy/_lib/doccer.py :139

Signature

def   extend_notes_in_docstring ( cls : object ,  notes : str )  →  Decorator

Summary

This decorator replaces the decorated function's docstring with the docstring from corresponding method in cls. It extends the 'Notes' section of that docstring to include the given notes.

Parameters

cls : type or object

A class with a method with the same name as the decorated method. The docstring of the method in this class replaces the docstring of the decorated method.

notes : str

Additional notes to append to the 'Notes' section of the docstring.

Returns

decfunc : function

The decorator function that modifies the __doc__ attribute of its argument.

Aliases

  • scipy.stats._continuous_distns.extend_notes_in_docstring