parse_prop_docs
FunctionSource
v_1: DocProp = parse_prop_docs(prop: property | cached_property, parent_name: str = "")
Parse the docstring of a class property.
Arguments
Requires
| Name | Type | Required | |
|---|---|---|---|
prop | property | cached_property | A class property/cached_property to be parsed. | |
parent_name | str | The name of the parent class. This value is only used for displaying logging messages. |
Returns
| Name | Type | |
|---|---|---|
v_1 | DocProp | The parsed docstring of the property. |