class documentation
class Docstring(_HasInitAttribsMethod): (source)
Known subclasses: pydocspec._model.Docstring
Represents a docstring for an #APIObject, i.e. it's content and location. This class is a subclass of str
for backwards compatibility reasons. Use the #content property to access the docstring content over the
#Docstring value directory.
| Method | __init__ |
Undocumented |
| Instance Variable | content |
The content of the docstring. While the #Docstring class is a subclass of str and holds the same value as content, using the #content property should be preferred as the inheritance from the str class may be removed in future versions. |
| Instance Variable | location |
The location of where the docstring is defined. |
Inherited from _HasInitAttribsMethod:
| Method | _init |
A method to define extra attributes that will be set after initialization. |