summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniƫl van Noord <13665637+DanielNoord@users.noreply.github.com>2022-02-07 23:38:04 +0100
committerGitHub <noreply@github.com>2022-02-07 23:38:04 +0100
commit533e6b8d64d344e8fdea23fc8fe6c1a4d0aa6286 (patch)
treed3d9e74bc90894718b755890fb380f8e4165d797
parent86cb7cf681af4c64cffa2f88c893179abab55d86 (diff)
downloadpylint-git-533e6b8d64d344e8fdea23fc8fe6c1a4d0aa6286.tar.gz
Fix duplicate names of ``Pylint Messages`` in docs (#5744)
Also add tbump step to upgrade the placeholder markdown, and an auto generation comment. Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
-rw-r--r--doc/exts/pylint_messages.py6
-rw-r--r--doc/messages/messages_introduction.rst4
-rw-r--r--doc/messages/messages_list.rst26
-rw-r--r--doc/release.md2
-rw-r--r--tbump.toml4
5 files changed, 36 insertions, 6 deletions
diff --git a/doc/exts/pylint_messages.py b/doc/exts/pylint_messages.py
index b737afbf4..32541788f 100644
--- a/doc/exts/pylint_messages.py
+++ b/doc/exts/pylint_messages.py
@@ -122,7 +122,11 @@ def _write_messages_list_page(
stream.write(
f""".. _messages-list:
-{get_rst_title("Pylint Messages", "=")}
+{get_rst_title("Overview of all Pylint messages", "=")}
+..
+ NOTE This file is auto-generated. Make any changes to the associated
+ docs extension in 'pylint_messages.py'.
+
Pylint can emit the following messages:
"""
diff --git a/doc/messages/messages_introduction.rst b/doc/messages/messages_introduction.rst
index 97a807d0f..e351d1b9b 100644
--- a/doc/messages/messages_introduction.rst
+++ b/doc/messages/messages_introduction.rst
@@ -1,7 +1,7 @@
.. _messages-introduction:
-Pylint messages
-================
+Message categories
+=====================
Pylint can emit various messages. These are categorized according to categories::
diff --git a/doc/messages/messages_list.rst b/doc/messages/messages_list.rst
index 6dd6c5b39..d28885741 100644
--- a/doc/messages/messages_list.rst
+++ b/doc/messages/messages_list.rst
@@ -1,7 +1,11 @@
.. _messages-list:
-Pylint Messages
-===============
+Overview of all Pylint messages
+===============================
+
+..
+ NOTE This file is auto-generated. Make any changes to the associated
+ docs extension in 'pylint_messages.py'.
Pylint can emit the following messages:
@@ -54,6 +58,7 @@ All messages in the error category:
error/bad-str-strip-call.rst
error/bad-string-format-type.rst
error/bad-super-call.rst
+ error/bidirectional-unicode.rst
error/catching-non-exception.rst
error/class-variable-slots-conflict.rst
error/continue-in-finally.rst
@@ -70,6 +75,12 @@ All messages in the error category:
error/invalid-all-object.rst
error/invalid-bool-returned.rst
error/invalid-bytes-returned.rst
+ error/invalid-character-backspace.rst
+ error/invalid-character-carriage-return.rst
+ error/invalid-character-esc.rst
+ error/invalid-character-nul.rst
+ error/invalid-character-sub.rst
+ error/invalid-character-zero-width-space.rst
error/invalid-class-object.rst
error/invalid-envvar-value.rst
error/invalid-format-returned.rst
@@ -88,6 +99,7 @@ All messages in the error category:
error/invalid-star-assignment-target.rst
error/invalid-str-returned.rst
error/invalid-unary-operand-type.rst
+ error/invalid-unicode-codec.rst
error/logging-format-truncated.rst
error/logging-too-few-args.rst
error/logging-too-many-args.rst
@@ -98,6 +110,8 @@ All messages in the error category:
error/missing-format-string-key.rst
error/missing-kwoa.rst
error/mixed-format-string.rst
+ error/modified-iterating-dict.rst
+ error/modified-iterating-set.rst
error/no-member.rst
error/no-method-argument.rst
error/no-name-in-module.rst
@@ -228,6 +242,7 @@ All messages in the warning category:
warning/logging-fstring-interpolation.rst
warning/logging-not-lazy.rst
warning/lost-exception.rst
+ warning/lru-cache-decorating-method.rst
warning/misplaced-future.rst
warning/missing-any-param-doc.rst
warning/missing-format-argument-key.rst
@@ -240,9 +255,11 @@ All messages in the warning category:
warning/missing-type-doc.rst
warning/missing-yield-doc.rst
warning/missing-yield-type-doc.rst
+ warning/modified-iterating-list.rst
warning/multiple-constructor-doc.rst
warning/nan-comparison.rst
warning/no-init.rst
+ warning/non-ascii-file-name.rst
warning/non-parent-init-called.rst
warning/non-str-assignment-to-dunder-name.rst
warning/overlapping-except.rst
@@ -257,6 +274,7 @@ All messages in the warning category:
warning/redeclared-assigned-name.rst
warning/redefined-builtin.rst
warning/redefined-outer-name.rst
+ warning/redefined-slots-in-subclass.rst
warning/redundant-returns-doc.rst
warning/redundant-u-string-prefix.rst
warning/redundant-unittest-assert.rst
@@ -274,6 +292,7 @@ All messages in the warning category:
warning/try-except-raise.rst
warning/unbalanced-tuple-unpacking.rst
warning/undefined-loop-variable.rst
+ warning/unnecessary-ellipsis.rst
warning/unnecessary-lambda.rst
warning/unnecessary-pass.rst
warning/unnecessary-semicolon.rst
@@ -327,6 +346,7 @@ All messages in the convention category:
convention/bad-classmethod-argument.rst
convention/bad-docstring-quotes.rst
+ convention/bad-file-encoding.rst
convention/bad-mcs-classmethod-argument.rst
convention/bad-mcs-method-argument.rst
convention/compare-to-empty-string.rst
@@ -351,6 +371,7 @@ All messages in the convention category:
convention/mixed-line-endings.rst
convention/multiple-imports.rst
convention/multiple-statements.rst
+ convention/non-ascii-module-import.rst
convention/non-ascii-name.rst
convention/single-string-used-for-slots.rst
convention/singleton-comparison.rst
@@ -382,6 +403,7 @@ All renamed messages in the convention category:
convention/len-as-condition.rst
convention/missing-docstring.rst
convention/old-misplaced-comparison-constant.rst
+ convention/old-non-ascii-name.rst
Refactor
diff --git a/doc/release.md b/doc/release.md
index 0854464af..e2196859e 100644
--- a/doc/release.md
+++ b/doc/release.md
@@ -6,7 +6,7 @@ So, you want to release the `X.Y.Z` version of pylint ?
1. Check if the dependencies of the package are correct, make sure that astroid is
pinned to the latest version.
-2. Install the release dependencies `pip3 install pre-commit tbump`
+2. Install the release dependencies `pip3 install pre-commit tbump tox`
3. Bump the version by using `tbump X.Y.Z --no-tag --no-push`
4. Check the result (Do `git diff vX.Y.Z-1 ChangeLog doc/whatsnew/` in particular).
5. Move back to a dev version for pylint with `tbump`:
diff --git a/tbump.toml b/tbump.toml
index b7855123d..0429cbd3a 100644
--- a/tbump.toml
+++ b/tbump.toml
@@ -29,6 +29,10 @@ name = "Upgrade changelog"
cmd = "python3 script/bump_changelog.py {new_version}"
[[before_commit]]
+name = "Upgrade and check doc"
+cmd = "tox -e docs||echo 'Hack so this command does not fail'"
+
+[[before_commit]]
name = "Upgrade copyrights"
cmd = "pip3 install copyrite;copyrite --contribution-threshold 1 --change-threshold 3 --backend-type git --aliases=.copyrite_aliases . --jobs=8"