docstring_parser.DocstringParam

class documentation

class DocstringParam(DocstringMeta): (source)

Constructor: DocstringParam(args, description, arg_name, type_name, ...)

View In Hierarchy

DocstringMeta symbolizing :param metadata.

Method __init__ Initialize self.
Instance Variable arg_name Undocumented
Instance Variable default Undocumented
Instance Variable is_optional Undocumented
Instance Variable type_name Undocumented

Inherited from DocstringMeta:

Instance Variable args Undocumented
Instance Variable description Undocumented
def __init__(self, args: list[str], description: str | None, arg_name: str, type_name: str | None, is_optional: bool | None, default: str | None): (source)
overrides docstring_parser.DocstringMeta.__init__

Initialize self.

arg_name = (source)

Undocumented

default = (source)

Undocumented

is_optional = (source)

Undocumented

type_name = (source)

Undocumented