Skip to content

Commit

Permalink
Fix duplicate names of Pylint Messages in docs (#5744)
Browse files Browse the repository at this point in the history
Also add tbump step to upgrade the placeholder markdown, and an auto generation comment. 

Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
  • Loading branch information
DanielNoord and Pierre-Sassoulas authored Feb 7, 2022
1 parent 86cb7cf commit 533e6b8
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 6 deletions.
6 changes: 5 additions & 1 deletion doc/exts/pylint_messages.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
"""
Expand Down
4 changes: 2 additions & 2 deletions doc/messages/messages_introduction.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _messages-introduction:

Pylint messages
================
Message categories
=====================

Pylint can emit various messages. These are categorized according to categories::

Expand Down
26 changes: 24 additions & 2 deletions doc/messages/messages_list.rst
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
4 changes: 4 additions & 0 deletions tbump.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ src = "pylint/__pkginfo__.py"
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"
Expand Down

0 comments on commit 533e6b8

Please sign in to comment.