Function add_help_to_file

examples/scripts/save_help_text.py:40–53

Write help text for commands and topics to the output file :param item: what is having its help text saved :param outfile: file being written to :param is_command: tells if the item is a command and not just a help topic.

(item: str, outfile: TextIO, is_command: bool)

def add_help_to_file(item: str, outfile: TextIO, is_command: bool) -> None:
    """Write help text for commands and topics to the output file

    :param item: what is having its help text saved
    :param outfile: file being written to
    :param is_command: tells if the item is a command and not just a help topic.
    """
    label = "COMMAND" if is_command else "TOPIC"

    header = f"{ASTERISKS}\n{label}: {item}\n{ASTERISKS}\n"
    outfile.write(header)

    result = app(f"help {item}")
    outfile.write(result.stdout)


def main() -> None: