Documentation

Defines a simple helper to populate a module’s __all__.

fsc.export.export(obj: T, name: Optional[str] = None) → T

Adds the decorated object to its module’s __all__.

Parameters

name (str) – Optional parameter to overwrite the object’s name that is written to __all__.

fsc.export.test_doc(enable: bool = True) → None

Test whether exported objects have a non-zero docstring. This must be called before the module is imported.

Parameters

enable – Determines whether the test should be enabled or disabled.