cfdm.FieldAncillary._docstring_package_depth

FieldAncillary._docstring_package_depth()

Returns the class {{package}} substitutions package depth.

In docstrings, {{package}} is replaced by the name of the package, as defined by the first N+1 . (dot) separated fields of the class’s __module__ attribute.

N defaults to 0, but may be set to any non-negative integer, M, by creating a __docstring_package_depth__ method that returns M.

New in version (cfdm): 1.8.7.0

See also

_docstring_special_substitutions, _docstring_substitutions, _docstring_method_exclusions, __docstring_substitutions__, __docstring_package_depth__, __docstring_method_exclusions__

Parameters

cls: class

The class.

Returns

int

The package depth.