diff options
author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-12-26 21:51:20 +0100 |
---|---|---|
committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-12-26 22:45:01 +0100 |
commit | 4a1c99ad5645ffbbac9b8224e3a2c06b22db5267 (patch) | |
tree | d181b8b3cfdaca83bff69d6449716c04fb45b4d1 | |
parent | 8b00b6ef5b216c00694a1801a8e808629c3ff9be (diff) | |
download | pylint-git-4a1c99ad5645ffbbac9b8224e3a2c06b22db5267.tar.gz |
Remove verbose docstring in code, keep them in example and doc
45 files changed, 0 insertions, 165 deletions
diff --git a/examples/deprecation_checker.py b/examples/deprecation_checker.py index 93db12295..d3dca4e07 100644 --- a/examples/deprecation_checker.py +++ b/examples/deprecation_checker.py @@ -94,8 +94,4 @@ class DeprecationChecker(DeprecatedMixin, BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(DeprecationChecker(linter)) diff --git a/pylint/checkers/async.py b/pylint/checkers/async.py index 3e6946d72..4a5c6abf2 100644 --- a/pylint/checkers/async.py +++ b/pylint/checkers/async.py @@ -99,8 +99,4 @@ class AsyncChecker(checkers.BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(AsyncChecker(linter)) diff --git a/pylint/checkers/base.py b/pylint/checkers/base.py index ee9c1719c..39ab5d673 100644 --- a/pylint/checkers/base.py +++ b/pylint/checkers/base.py @@ -2589,10 +2589,6 @@ class ComparisonChecker(_BasicChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(BasicErrorChecker(linter)) linter.register_checker(BasicChecker(linter)) linter.register_checker(NameChecker(linter)) diff --git a/pylint/checkers/classes/__init__.py b/pylint/checkers/classes/__init__.py index 4eb47feef..2b0e595e6 100644 --- a/pylint/checkers/classes/__init__.py +++ b/pylint/checkers/classes/__init__.py @@ -11,9 +11,5 @@ if TYPE_CHECKING: def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(ClassChecker(linter)) linter.register_checker(SpecialMethodsChecker(linter)) diff --git a/pylint/checkers/design_analysis.py b/pylint/checkers/design_analysis.py index ca5987357..ec518e857 100644 --- a/pylint/checkers/design_analysis.py +++ b/pylint/checkers/design_analysis.py @@ -666,8 +666,4 @@ class MisdesignChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(MisdesignChecker(linter)) diff --git a/pylint/checkers/ellipsis_checker.py b/pylint/checkers/ellipsis_checker.py index ab1c14be4..e5d4c4ecd 100644 --- a/pylint/checkers/ellipsis_checker.py +++ b/pylint/checkers/ellipsis_checker.py @@ -50,8 +50,4 @@ class EllipsisChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(EllipsisChecker(linter)) diff --git a/pylint/checkers/exceptions.py b/pylint/checkers/exceptions.py index 377aab2f7..0d60b0a39 100644 --- a/pylint/checkers/exceptions.py +++ b/pylint/checkers/exceptions.py @@ -575,8 +575,4 @@ class ExceptionsChecker(checkers.BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(ExceptionsChecker(linter)) diff --git a/pylint/checkers/format.py b/pylint/checkers/format.py index b75fc74ca..17a50911c 100644 --- a/pylint/checkers/format.py +++ b/pylint/checkers/format.py @@ -824,8 +824,4 @@ class FormatChecker(BaseTokenChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(FormatChecker(linter)) diff --git a/pylint/checkers/imports.py b/pylint/checkers/imports.py index 1e542a9c5..528f7d80c 100644 --- a/pylint/checkers/imports.py +++ b/pylint/checkers/imports.py @@ -1021,8 +1021,4 @@ class ImportsChecker(DeprecatedMixin, BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(ImportsChecker(linter)) diff --git a/pylint/checkers/logging.py b/pylint/checkers/logging.py index 1323c0233..19e04c7d1 100644 --- a/pylint/checkers/logging.py +++ b/pylint/checkers/logging.py @@ -405,8 +405,4 @@ def _count_supplied_tokens(args): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(LoggingChecker(linter)) diff --git a/pylint/checkers/misc.py b/pylint/checkers/misc.py index 870a33733..4eb52336d 100644 --- a/pylint/checkers/misc.py +++ b/pylint/checkers/misc.py @@ -199,9 +199,5 @@ class EncodingChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(EncodingChecker(linter)) linter.register_checker(ByIdManagedMessagesChecker(linter)) diff --git a/pylint/checkers/newstyle.py b/pylint/checkers/newstyle.py index e2b5f8240..b19a5c7ef 100644 --- a/pylint/checkers/newstyle.py +++ b/pylint/checkers/newstyle.py @@ -138,8 +138,4 @@ class NewStyleConflictChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(NewStyleConflictChecker(linter)) diff --git a/pylint/checkers/raw_metrics.py b/pylint/checkers/raw_metrics.py index 4edfd41bb..379665eac 100644 --- a/pylint/checkers/raw_metrics.py +++ b/pylint/checkers/raw_metrics.py @@ -126,8 +126,4 @@ def get_type(tokens, start_index): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(RawMetricsChecker(linter)) diff --git a/pylint/checkers/refactoring/__init__.py b/pylint/checkers/refactoring/__init__.py index 9211b98e9..8c873c698 100644 --- a/pylint/checkers/refactoring/__init__.py +++ b/pylint/checkers/refactoring/__init__.py @@ -59,10 +59,6 @@ __all__ = [ def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(RefactoringChecker(linter)) linter.register_checker(NotChecker(linter)) linter.register_checker(RecommendationChecker(linter)) diff --git a/pylint/checkers/similar.py b/pylint/checkers/similar.py index 56aaa8847..112cd4bbb 100644 --- a/pylint/checkers/similar.py +++ b/pylint/checkers/similar.py @@ -883,10 +883,6 @@ class SimilarChecker(BaseChecker, Similar, MapReduceMixin): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(SimilarChecker(linter)) diff --git a/pylint/checkers/spelling.py b/pylint/checkers/spelling.py index 1b3854e1c..012c396de 100644 --- a/pylint/checkers/spelling.py +++ b/pylint/checkers/spelling.py @@ -474,8 +474,4 @@ class SpellingChecker(BaseTokenChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(SpellingChecker(linter)) diff --git a/pylint/checkers/stdlib.py b/pylint/checkers/stdlib.py index 198eb23ae..7093bb0da 100644 --- a/pylint/checkers/stdlib.py +++ b/pylint/checkers/stdlib.py @@ -726,8 +726,4 @@ class StdlibChecker(DeprecatedMixin, BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(StdlibChecker(linter)) diff --git a/pylint/checkers/strings.py b/pylint/checkers/strings.py index 03a633ff9..e4dcfc831 100644 --- a/pylint/checkers/strings.py +++ b/pylint/checkers/strings.py @@ -929,10 +929,6 @@ class StringConstantChecker(BaseTokenChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(StringFormatChecker(linter)) linter.register_checker(StringConstantChecker(linter)) diff --git a/pylint/checkers/threading_checker.py b/pylint/checkers/threading_checker.py index 27449d138..cedf46a9e 100644 --- a/pylint/checkers/threading_checker.py +++ b/pylint/checkers/threading_checker.py @@ -56,8 +56,4 @@ class ThreadingChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(ThreadingChecker(linter)) diff --git a/pylint/checkers/typecheck.py b/pylint/checkers/typecheck.py index e42680189..be4fa61be 100644 --- a/pylint/checkers/typecheck.py +++ b/pylint/checkers/typecheck.py @@ -2103,9 +2103,5 @@ class IterableChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(TypeChecker(linter)) linter.register_checker(IterableChecker(linter)) diff --git a/pylint/checkers/unsupported_version.py b/pylint/checkers/unsupported_version.py index feec10893..64078aa68 100644 --- a/pylint/checkers/unsupported_version.py +++ b/pylint/checkers/unsupported_version.py @@ -85,8 +85,4 @@ class UnsupportedVersionChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(UnsupportedVersionChecker(linter)) diff --git a/pylint/checkers/variables.py b/pylint/checkers/variables.py index 17a2c7416..8bfdc197e 100644 --- a/pylint/checkers/variables.py +++ b/pylint/checkers/variables.py @@ -2531,8 +2531,4 @@ class VariablesChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(VariablesChecker(linter)) diff --git a/pylint/extensions/bad_builtin.py b/pylint/extensions/bad_builtin.py index c51b421af..197bf231b 100644 --- a/pylint/extensions/bad_builtin.py +++ b/pylint/extensions/bad_builtin.py @@ -70,8 +70,4 @@ class BadBuiltinChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(BadBuiltinChecker(linter)) diff --git a/pylint/extensions/broad_try_clause.py b/pylint/extensions/broad_try_clause.py index 535792910..a45dc5fe6 100644 --- a/pylint/extensions/broad_try_clause.py +++ b/pylint/extensions/broad_try_clause.py @@ -76,8 +76,4 @@ class BroadTryClauseChecker(checkers.BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(BroadTryClauseChecker(linter)) diff --git a/pylint/extensions/check_docs.py b/pylint/extensions/check_docs.py index 173af9ffb..141f51298 100644 --- a/pylint/extensions/check_docs.py +++ b/pylint/extensions/check_docs.py @@ -18,10 +18,6 @@ if TYPE_CHECKING: def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ warnings.warn( "This plugin is deprecated, use pylint.extensions.docparams instead.", DeprecationWarning, diff --git a/pylint/extensions/check_elif.py b/pylint/extensions/check_elif.py index e443b7a13..b4658577e 100644 --- a/pylint/extensions/check_elif.py +++ b/pylint/extensions/check_elif.py @@ -68,8 +68,4 @@ class ElseifUsedChecker(BaseTokenChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(ElseifUsedChecker(linter)) diff --git a/pylint/extensions/code_style.py b/pylint/extensions/code_style.py index 36a755dc8..e3149bb8d 100644 --- a/pylint/extensions/code_style.py +++ b/pylint/extensions/code_style.py @@ -305,8 +305,4 @@ class CodeStyleChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(CodeStyleChecker(linter)) diff --git a/pylint/extensions/comparetozero.py b/pylint/extensions/comparetozero.py index dece2b676..592e15a5b 100644 --- a/pylint/extensions/comparetozero.py +++ b/pylint/extensions/comparetozero.py @@ -81,8 +81,4 @@ class CompareToZeroChecker(checkers.BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(CompareToZeroChecker(linter)) diff --git a/pylint/extensions/comparison_placement.py b/pylint/extensions/comparison_placement.py index 92f3511ea..2a116f824 100644 --- a/pylint/extensions/comparison_placement.py +++ b/pylint/extensions/comparison_placement.py @@ -68,8 +68,5 @@ class MisplacedComparisonConstantChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(MisplacedComparisonConstantChecker(linter)) diff --git a/pylint/extensions/confusing_elif.py b/pylint/extensions/confusing_elif.py index e21ad6d27..f8293b2b2 100644 --- a/pylint/extensions/confusing_elif.py +++ b/pylint/extensions/confusing_elif.py @@ -55,8 +55,5 @@ class ConfusingConsecutiveElifChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(ConfusingConsecutiveElifChecker(linter)) diff --git a/pylint/extensions/consider_ternary_expression.py b/pylint/extensions/consider_ternary_expression.py index b24452484..6dabe3613 100644 --- a/pylint/extensions/consider_ternary_expression.py +++ b/pylint/extensions/consider_ternary_expression.py @@ -50,8 +50,4 @@ class ConsiderTernaryExpressionChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(ConsiderTernaryExpressionChecker(linter)) diff --git a/pylint/extensions/docparams.py b/pylint/extensions/docparams.py index 0a04a211f..47be55bad 100644 --- a/pylint/extensions/docparams.py +++ b/pylint/extensions/docparams.py @@ -666,8 +666,5 @@ class DocstringParameterChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(DocstringParameterChecker(linter)) diff --git a/pylint/extensions/docstyle.py b/pylint/extensions/docstyle.py index c189f24a8..89c22cb5b 100644 --- a/pylint/extensions/docstyle.py +++ b/pylint/extensions/docstyle.py @@ -91,8 +91,5 @@ class DocStringStyleChecker(checkers.BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(DocStringStyleChecker(linter)) diff --git a/pylint/extensions/empty_comment.py b/pylint/extensions/empty_comment.py index 1620fe8cb..2e36b7c7b 100644 --- a/pylint/extensions/empty_comment.py +++ b/pylint/extensions/empty_comment.py @@ -60,8 +60,5 @@ class CommentChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(CommentChecker(linter)) diff --git a/pylint/extensions/emptystring.py b/pylint/extensions/emptystring.py index cc29be5bb..0193bab96 100644 --- a/pylint/extensions/emptystring.py +++ b/pylint/extensions/emptystring.py @@ -76,8 +76,5 @@ class CompareToEmptyStringChecker(checkers.BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(CompareToEmptyStringChecker(linter)) diff --git a/pylint/extensions/for_any_all.py b/pylint/extensions/for_any_all.py index 67d0f6701..4e5d37115 100644 --- a/pylint/extensions/for_any_all.py +++ b/pylint/extensions/for_any_all.py @@ -66,8 +66,5 @@ class ConsiderUsingAnyOrAllChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(ConsiderUsingAnyOrAllChecker(linter)) diff --git a/pylint/extensions/mccabe.py b/pylint/extensions/mccabe.py index fe21a5950..98dfb9899 100644 --- a/pylint/extensions/mccabe.py +++ b/pylint/extensions/mccabe.py @@ -200,8 +200,5 @@ class McCabeMethodChecker(checkers.BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(McCabeMethodChecker(linter)) diff --git a/pylint/extensions/overlapping_exceptions.py b/pylint/extensions/overlapping_exceptions.py index 1f50a4c03..e246e2dec 100644 --- a/pylint/extensions/overlapping_exceptions.py +++ b/pylint/extensions/overlapping_exceptions.py @@ -85,8 +85,5 @@ class OverlappingExceptionsChecker(checkers.BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(OverlappingExceptionsChecker(linter)) diff --git a/pylint/extensions/redefined_variable_type.py b/pylint/extensions/redefined_variable_type.py index 00506994a..1de7be808 100644 --- a/pylint/extensions/redefined_variable_type.py +++ b/pylint/extensions/redefined_variable_type.py @@ -115,8 +115,5 @@ class MultipleTypesChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(MultipleTypesChecker(linter)) diff --git a/pylint/extensions/set_membership.py b/pylint/extensions/set_membership.py index 06b137a06..c7565e511 100644 --- a/pylint/extensions/set_membership.py +++ b/pylint/extensions/set_membership.py @@ -48,8 +48,5 @@ class SetMembershipChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(SetMembershipChecker(linter)) diff --git a/pylint/extensions/typing.py b/pylint/extensions/typing.py index cbf11f3ee..dd62ad85b 100644 --- a/pylint/extensions/typing.py +++ b/pylint/extensions/typing.py @@ -281,8 +281,5 @@ class TypingChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(TypingChecker(linter)) diff --git a/pylint/extensions/while_used.py b/pylint/extensions/while_used.py index ab1c01764..e5b56c299 100644 --- a/pylint/extensions/while_used.py +++ b/pylint/extensions/while_used.py @@ -29,8 +29,5 @@ class WhileChecker(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_checker(WhileChecker(linter)) diff --git a/pylint/reporters/json_reporter.py b/pylint/reporters/json_reporter.py index efca290ac..3ba0f5912 100644 --- a/pylint/reporters/json_reporter.py +++ b/pylint/reporters/json_reporter.py @@ -59,8 +59,5 @@ class JSONReporter(BaseReporter): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_reporter(JSONReporter) diff --git a/pylint/reporters/text.py b/pylint/reporters/text.py index 643a2001f..aa84f74d8 100644 --- a/pylint/reporters/text.py +++ b/pylint/reporters/text.py @@ -352,10 +352,7 @@ class ColorizedTextReporter(TextReporter): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - :param linter: The linter to register the checker to. - """ linter.register_reporter(TextReporter) linter.register_reporter(ParseableTextReporter) linter.register_reporter(VSTextReporter) diff --git a/tests/regrtest_data/dummy_plugin/dummy_plugin.py b/tests/regrtest_data/dummy_plugin/dummy_plugin.py index 265481a70..22b0ea391 100644 --- a/tests/regrtest_data/dummy_plugin/dummy_plugin.py +++ b/tests/regrtest_data/dummy_plugin/dummy_plugin.py @@ -27,9 +27,5 @@ class DummyPlugin2(BaseChecker): def register(linter: "PyLinter") -> None: - """This required method auto registers the checker during initialization. - - :param linter: The linter to register the checker to. - """ linter.register_checker(DummyPlugin1(linter)) linter.register_checker(DummyPlugin2(linter)) |