docspec.Docstring

class documentation

class Docstring(str):

View In Hierarchy

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.

Added in 1.1.0.

Method __new__ Undocumented
Class Variable content Undocumented
Class Variable location Undocumented
def __new__(cls, content, location):

Undocumented

Parameters
content:strUndocumented
location:t.Optional[Location]Undocumented
Returns
DocstringUndocumented
content: str =

Undocumented

location: t.Optional[Location] =

Undocumented