DocModuleMetadata
ClassDataClassSource
DocModuleMetadata(
title: str = "", author: str = "", license: str = "", descr: str = ""
)
The module metadata extracted from the top docstring.
Fields
| Name | Type | Required | |
|---|---|---|---|
title | str | The module title. | |
author | str | The author section specified in the docstring. | |
license | str | The license section specified in the docstring. | |
descr | str | The description body specified in the docstring. |
Methods
from_long_descr
v_1: Self = DocModuleMetadata.from_long_descr(text: str)
Parse the long description texts (many sections) as the metadata.
Requires
| Name | Type | Required | |
|---|---|---|---|
text | str | The long module docstring text. |
Returns
| Name | Type | |
|---|---|---|
v_1 | Self | The parsed module metadata. |