stubber.commands.enrich_folder_cmd

Enrich mcu/firmware stubs with information from the docstubs

Functions

cli_enrich_folder(dest_folder, source_folder[, diff, ...])

Enrich the stubs in stub_folder with the docstubs in docstubs_folder.

Module Contents

stubber.commands.enrich_folder_cmd.cli_enrich_folder(dest_folder: str | pathlib.Path, source_folder: str | pathlib.Path, diff: bool = False, dry_run: bool = False, copy_params: bool = True, copy_docstr: bool = False)

Enrich the stubs in stub_folder with the docstubs in docstubs_folder.

Parameters:

• dest_folder (Union[str, pathlib.Path])

• source_folder (Union[str, pathlib.Path])

• diff (bool)

• dry_run (bool)

• copy_params (bool)

• copy_docstr (bool)