diff options
| author | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2022-06-06 10:42:17 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-06 10:42:17 +0200 |
| commit | 0da426fd3750de02a1cf358c034e3f888c8e6bee (patch) | |
| tree | 8dcf450d717c967b3e187e7f63888e360151a0aa /pylint/checkers/base_checker.py | |
| parent | a5ca674cf12f3bffbd90370c7595ec2f20abe953 (diff) | |
| download | pylint-git-0da426fd3750de02a1cf358c034e3f888c8e6bee.tar.gz | |
Remove redundant options documentation and improve formatting (#6665)
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Diffstat (limited to 'pylint/checkers/base_checker.py')
| -rw-r--r-- | pylint/checkers/base_checker.py | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/pylint/checkers/base_checker.py b/pylint/checkers/base_checker.py index 6515d107e..a2dfe7b17 100644 --- a/pylint/checkers/base_checker.py +++ b/pylint/checkers/base_checker.py @@ -109,6 +109,7 @@ class BaseChecker(_ArgumentsProvider): reports: tuple[tuple[str, str, ReportsCallable], ...], doc: str | None = None, module: str | None = None, + show_options: bool = True, ) -> str: result = "" checker_title = f"{self.name.replace('_', ' ').title()} checker" @@ -126,8 +127,11 @@ class BaseChecker(_ArgumentsProvider): # options might be an empty generator and not be False when cast to boolean options_list = list(options) if options_list: - result += get_rst_title(f"{checker_title} Options", "^") - result += f"{get_rst_section(None, options_list)}\n" + if show_options: + result += get_rst_title(f"{checker_title} Options", "^") + result += f"{get_rst_section(None, options_list)}\n" + else: + result += f"See also :ref:`{self.name} checker's options' documentation <{self.name}-options>`\n\n" if msgs: result += get_rst_title(f"{checker_title} Messages", "^") for msgid, msg in sorted( |