cfdm.RaggedIndexedArray._docstring_special_substitutions¶
-
classmethod
RaggedIndexedArray.
_docstring_special_substitutions
()[source]¶ Return the special docstring substitutions.
{{class}}
is replaced by the name of the class.{{class_lower}}
is replaced by the name of the class convert to all lower case.{{package}}
is replaced by the name of the package, as defined by the first N.
(dot) separated fields of the class’s__module__
attribute, where is N determined by_docstring_package_depth
.New in version (cfdm): 1.8.7.0
See also
_docstring_package_depth
,_docstring_method_exclusions
,_docstring_substitutions
,__docstring_substitutions__
,__docstring_package_depth__
,__docstring_method_exclusions__
- Returns
tuple
The special docstring substitution identifiers.