pylint.utils.docs

module documentation
(source)

Various helper functions to create the docs of a linter object.

Function _get_checkers_documentation Get documentation for individual checkers.
Function _get_checkers_infos Get info from a checker and handle KeyError.
Function _get_global_options_documentation Get documentation for the main checker.
def _get_checkers_documentation(linter: PyLinter, show_options: bool = True) -> str: (source)

Get documentation for individual checkers.

def _get_checkers_infos(linter: PyLinter) -> dict[str, dict[str, Any]]: (source)

Get info from a checker and handle KeyError.

def _get_global_options_documentation(linter: PyLinter) -> str: (source)

Get documentation for the main checker.