Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix duplicate names of Pylint Messages in docs #5744

Merged
5 changes: 4 additions & 1 deletion doc/exts/pylint_messages.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,10 @@ def _write_messages_list_page(
stream.write(
f""".. _messages-list:

{get_rst_title("Pylint Messages", "=")}
.. NOTE: This file is auto-generated. Make any changes to the associated
.. docs extension in '{__name__}.py'.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Smart!


{get_rst_title("Overview of all Pylint messages", "=")}
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
7 changes: 5 additions & 2 deletions doc/messages/messages_list.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
.. _messages-list:

Pylint Messages
===============
.. NOTE: This file is auto-generated. Make any changes to the associated
.. docs extension in 'pylint_messages.py'.

Overview of all Pylint messages
=================================

Pylint can emit the following messages:

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