cfdm.Field._docstring_method_exclusions

Field._docstring_method_exclusions()[source]

Return the names of methods to exclude from docstring substitutions for the given class.

Exclusions for a class may be defined by creating a __docstring_method_exclusions__ method that returns the sequence of names of methods to be excluded. These exclusions will also apply to any child classes.

Exclsusions may be defined for any reason, but in particular may be required if a method has a non-rewriteable docstring. An example of method that has a non-rewritable docstring is when the method is a ‘method_descriptor’ object, such as list.append: any class that inherits such such a method will need to exclude it, unless it is explicitly overridden in the child class.

New in version (cfdm): 1.8.7.0

See also

_docstring_special_substitutions, _docstring_substitutions, _docstring_package_depth, __docstring_substitutions__, __docstring_package_depth__, __docstring_method_exclusions__

Parameters
cls: class

The class.

Returns
set

The names of the methods to exclude from the docstring substutition process.