papyri
{ } Raw JSON

bundles / papyri 0.0.10 / papyri / gen / Gen / extract_docstring

function

papyri.gen:Gen.extract_docstring

source: /papyri/gen.py:1786

Signature

def extract_docstring(self, *, qa: str, target_item: Any) → tuple[str | None, list[Section], APIObjectInfo]

Summary

Extract docstring from an object.

Extended Summary

Detects whether an object includes a docstring and parses the object's type.

Parameters

qa : str

Fully qualified name of the object we are extracting the documentation from

target_item : Any

Object we wish inspect. Can be any kind of object.

Returns

item_docstring : str

The unprocessed object's docstring

sections : list of Section

A list of serialized sections of the docstring

api_object : APIObjectInfo

Describes the object's type and other relevant information

Aliases

  • papyri.gen.Gen.extract_docstring