pestifer.subcommands.config_help module

The config-help subcommand. This subcommand exposes Ycleptic’s built-in interactive help system for exploring Pestifer’s base configuration. The user can specify the entry point using the directives argument, and can disable interactivity using the --no-interactive flag.

class pestifer.subcommands.config_help.ConfigHelpSubcommand(name: str = 'config-help', aliases: list = <factory>, log_file: str = 'pestifer_diagnostics.log', short_help: str = 'show help for configuration options', long_help: str = 'Display help information for all available configuration options.', func_returns_type: type = <class 'bool'>, parser: argparse.ArgumentParser = None)

Bases: Subcommand

add_subparser(subparsers)

Adds the subcommand parser to the given subparsers. Subclasses declare arguments here, after a super().add_subparser() call.

static func(args: Namespace, **kwargs)

the function that executes the subcommand. Subclasses must implement this method.

long_help: str = 'Display help information for all available configuration options.'

description

name: str = 'config-help'

subcommand name

short_help: str = 'show help for configuration options'

help string