DocField

ClassDataClassSource

DocField(
    name: str,
    type: str,
    default: str = "",
    init_skipped: bool = False,
    descr: str = "",
    doc: str = ""
)

The docstring of a data model/class field.

Fields

Name	Type	Required	Description
name	str		The name of the field.
type	str		The type of the field. It is usually the typehint (annotation).
default	str		The formatted default value of the field.
init_skipped	bool		A flag. If specified, this field should be skipped in the initialization.
descr	str		The docstring of the field, it is defined in codes.
doc	str		The extra dynamic/run-time docstring of the field. It is not used when rendering the documentation.