GitHub

Formatter

API reference for Formatter.

Functions

format_help_doc

format_help_doc(doc) -> str
ParameterTypeDescription
docHelpDoc

Returns str

def format_help_doc(self, doc: HelpDoc) -> str: ...

format_cli_error

format_cli_error(error) -> str
ParameterTypeDescription
errorCliError

Returns str

def format_cli_error(self, error: CliError) -> str: ...

format_error

format_error(error) -> str
ParameterTypeDescription
errorCliError

Returns str

def format_error(self, error: CliError) -> str: ...

format_version

format_version(name, version) -> str
ParameterTypeDescription
namestr
versionstr

Returns str

def format_version(self, name: str, version: str) -> str: ...

format_errors

format_errors(errors) -> str
ParameterTypeDescription
errorsSequence[CliError]

Returns str

def format_errors(self, errors: Sequence[CliError]) -> str: ...