add_common_docstring#

class sunpy.util.add_common_docstring(append=None, prepend=None, **kwargs)[source]#

Bases: object

A function decorator that will append and/or prepend an addendum to the docstring of the target function.

Parameters:

  • append (str, optional) – A string to append to the end of the functions docstring.

  • prepend (str, optional) – A string to prepend to the start of the functions docstring.

  • **kwargs (dict, optional) – A dictionary to format append and prepend strings.

Methods Summary

__call__(func)

Call self as a function.

Methods Documentation

__call__(func)[source]#

Call self as a function.