Parameter

Stores parameter information in `DocumentedFunction` and `DocumentedClass`.

Bases
typing.TypedDict

Attributes

  • Name
    name
    Type
    str
    Value

    = None

    Description

  • Name
    description
    Type
    str
    Value

    = None

    Description

  • Name
    kind
    Type
    str
    Value

    = None

    Description

  • Name
    annotation
    Type
    typing.Union[dict[str, typing.Any], str]
    Value

    = None

    Description

  • Name
    required
    Type
    bool
    Value

    = None

    Description

  • Name
    default
    Type
    typing.Optional[typing.Union[dict[str, str], str]]
    Value

    = None

    Description

Copyright © 2024