Skip to main content

DocModuleProp

ClassDataClassSource

DocModuleProp(
name: str,
descr: str = "",
type: Literal["package", "module", "class", "func", "type"] = "package",
slang: str = ""
)

The docstring and basic information of a module property.

Fields

NameTypeRequired
Description
namestrThe name of the module property.
descrstrThe description body, i.e., the docstring of the module property.
typeLiteral["package", "module", "class", "func", "type"]The type of the module property.
slangstrThe internal code identifying this property.