From 502fd4b787458e10025692387b42c2efd28cde5e Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Thu, 10 Feb 2022 22:16:48 +0100 Subject: [PATCH 1/2] Fix the period added in docstring automatically by mistake Due to https://github.com/DanielNoord/pydocstringformatter/pull/52 --- .pre-commit-config.yaml | 2 +- pylint/checkers/format.py | 2 +- pylint/lint/run.py | 2 +- pylint/pyreverse/diadefslib.py | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 33de05026c..0757c41c10 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -96,7 +96,7 @@ repos: args: [--prose-wrap=always, --print-width=88] exclude: tests(/.*)*/data - repo: https://github.com/DanielNoord/pydocstringformatter - rev: v0.4.0 + rev: a9f94bf13b08fe33f784ed7f0a0fc39e2a8549e2 hooks: - id: pydocstringformatter exclude: *fixtures diff --git a/pylint/checkers/format.py b/pylint/checkers/format.py index fe505a66d5..799d97cbc5 100644 --- a/pylint/checkers/format.py +++ b/pylint/checkers/format.py @@ -471,7 +471,7 @@ def _prepare_token_dispatcher(self): return dispatch def process_tokens(self, tokens): - """Process tokens and search for :. + """Process tokens and search for : _ too long lines (i.e. longer than ) _ optionally bad construct (if given, bad_construct must be a compiled diff --git a/pylint/lint/run.py b/pylint/lint/run.py index 25311024a2..00fda5e206 100644 --- a/pylint/lint/run.py +++ b/pylint/lint/run.py @@ -55,7 +55,7 @@ def cb_init_hook(optname, value): class Run: - """Helper class to use as main for pylint :. + """Helper class to use as main for pylint : run(*sys.argv[1:]) """ diff --git a/pylint/pyreverse/diadefslib.py b/pylint/pyreverse/diadefslib.py index 44a593849c..b1ce77bfbb 100644 --- a/pylint/pyreverse/diadefslib.py +++ b/pylint/pyreverse/diadefslib.py @@ -126,7 +126,7 @@ def extract_classes(self, klass_node, anc_level, association_level): class DefaultDiadefGenerator(LocalsVisitor, DiaDefGenerator): - """Generate minimum diagram definition for the project :. + """Generate minimum diagram definition for the project : * a package diagram including project's modules * a class diagram including project's classes @@ -210,7 +210,7 @@ def class_diagram(self, project, klass): class DiadefsHandler: - """Handle diagram definitions :. + """Handle diagram definitions : get it from user (i.e. xml files) or generate them """ From 3808bdb46a52a8ac0b4bc4ece54b565259ede804 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Thu, 10 Feb 2022 22:31:07 +0100 Subject: [PATCH 2/2] Apply suggestions from code review --- pylint/lint/run.py | 5 +---- pylint/pyreverse/diadefslib.py | 5 +---- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/pylint/lint/run.py b/pylint/lint/run.py index 00fda5e206..6cbdc5cc71 100644 --- a/pylint/lint/run.py +++ b/pylint/lint/run.py @@ -55,10 +55,7 @@ def cb_init_hook(optname, value): class Run: - """Helper class to use as main for pylint : - - run(*sys.argv[1:]) - """ + """Helper class to use as main for pylint with 'run(*sys.argv[1:])'.""" LinterClass = PyLinter option_groups = ( diff --git a/pylint/pyreverse/diadefslib.py b/pylint/pyreverse/diadefslib.py index b1ce77bfbb..6fa8ea107b 100644 --- a/pylint/pyreverse/diadefslib.py +++ b/pylint/pyreverse/diadefslib.py @@ -210,10 +210,7 @@ def class_diagram(self, project, klass): class DiadefsHandler: - """Handle diagram definitions : - - get it from user (i.e. xml files) or generate them - """ + """Get diagram definitions from user (i.e. xml files) or generate them.""" def __init__(self, config): self.config = config