pydocspec.processor.mod_attr

module documentation
(source)

Helpers to populate attributes of Module instances.

Function docformat Undocumented
Function dunder_all Undocumented
Function is_package Undocumented
Function public_names A name is public if it does not start by an underscore. Submodules are not imported when wildcard importing a module, so they are not listed as part of the public names.
def docformat(ob): (source)

Undocumented

Parameters
ob:_model.ModuleUndocumented
Returns
Optional[str]Undocumented
def dunder_all(ob): (source)

Undocumented

Parameters
ob:_model.ModuleUndocumented
Returns
Optional[List[str]]Undocumented
def is_package(ob): (source)

Undocumented

Parameters
ob:_model.ModuleUndocumented
Returns
boolUndocumented
def public_names(ob): (source)

A name is public if it does not start by an underscore. Submodules are not imported when wildcard importing a module, so they are not listed as part of the public names.

Parameters
ob:_model.ModuleUndocumented
Returns
List[str]Undocumented
Note
This is used to resolve wildcard imports when no __all__ variable is defined.