Path 1: 1 calls (1.0)

PyLinter (1)

True (1)

'Pylint global options and switches\n----------------------------------\n\nPylint provides global options and switches.\n\nGeneral options\n~~~~~~~~~~...

1def _get_checkers_documentation(linter: PyLinter, show_options: bool = True) -> str:
2    """Get documentation for individual checkers."""
3    if show_options:
4        result = _get_global_options_documentation(linter)
5    else:
6        result = ""
7
8    result += get_rst_title("Pylint checkers' options and switches", "-")
9    result += """\
10
11Pylint checkers can provide three set of features:
12
13* options that control their execution,
14* messages that they can raise,
15* reports that they can generate.
16
17Below is a list of all checkers and their features.
18
19"""
20    by_checker = _get_checkers_infos(linter)
21    for checker_name in sorted(by_checker):
22        information = by_checker[checker_name]
23        checker = information["checker"]
24        del information["checker"]
25        result += checker.get_full_documentation(
26            **information, show_options=show_options
27        )
28    return result