diff options
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 2 | ||||
| -rw-r--r-- | .pre-commit-config.yaml | 5 | ||||
| -rw-r--r-- | MANIFEST.in | 1 | ||||
| -rw-r--r-- | doc/development_guide/contributor_guide/contribute.rst | 12 | ||||
| -rw-r--r-- | doc/development_guide/contributor_guide/release.md | 8 | ||||
| -rw-r--r-- | doc/whatsnew/2/2.14/full.rst | 2 | ||||
| -rw-r--r-- | doc/whatsnew/2/2.3/summary.rst | 2 | ||||
| -rw-r--r-- | script/bump_changelog.py | 1 | ||||
| -rw-r--r-- | script/fix_documentation.py | 1 |
9 files changed, 17 insertions, 17 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3209a6385..2163a1719 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,7 +23,7 @@ To ease the process of reviewing your PR, do make sure to complete the following ## Description -<!-- If this PR reference an issue without fixing it: --> +<!-- If this PR references an issue without fixing it: --> Refs #XXXX diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 80e34cb8b..33f30c0da 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -79,14 +79,13 @@ repos: entry: python3 -m script.fix_documentation language: system types: [text] - files: ^(ChangeLog|doc/whatsnew/\d+\.\d+\.rst) + files: ^(doc/whatsnew/\d+\.\d+\.rst) - repo: https://github.com/rstcheck/rstcheck rev: "v6.0.0rc2" hooks: - id: rstcheck args: ["--report-level=warning"] - types: [text] # necessary to include ChangeLog file - files: ^(ChangeLog|doc/(.*/)*.*\.rst) + files: ^(doc/(.*/)*.*\.rst) additional_dependencies: [Sphinx==4.5.0] - repo: https://github.com/pre-commit/mirrors-mypy rev: v0.950 diff --git a/MANIFEST.in b/MANIFEST.in index 0ea68b181..d35466894 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -6,7 +6,6 @@ prune examples prune tests prune script exclude .* -exclude ChangeLog exclude Dockerfile exclude README.rst exclude pylintrc diff --git a/doc/development_guide/contributor_guide/contribute.rst b/doc/development_guide/contributor_guide/contribute.rst index 74fe565b7..efc640d5a 100644 --- a/doc/development_guide/contributor_guide/contribute.rst +++ b/doc/development_guide/contributor_guide/contribute.rst @@ -34,13 +34,13 @@ of Pylint as it gives you access to the latest ``ast`` parser. * then run ``pre-commit install`` in the ``pylint`` root directory to enable the git hooks. -- Add a short entry to the ChangeLog describing the change, except for internal - implementation only changes. Not usually required, but for changes other than small - bugs we also add a couple of sentences in the release document for that release, - (`What's New` section). For the release document we usually write some more details, - and it is also a good place to offer examples on how the new change is supposed to work. +- Add a short entry to the change log describing the change, except for internal + implementation only changes. -- Add a short entry in :file:`doc/whatsnew/VERSION.rst`. +- Not usually required, but for changes other than small bugs we also add a couple + of sentences in the release document for that release, (:file:`doc/whatsnew/VERSION.rst`, + `What's New` section). For the release document we usually write some more details, + and it is also a good place to offer examples on how the new change is supposed to work. - If you used multiple emails or multiple names when contributing, add your mails and preferred name in the ``script/.contributors_aliases.json`` file. diff --git a/doc/development_guide/contributor_guide/release.md b/doc/development_guide/contributor_guide/release.md index 6953e7e3d..24bcc3749 100644 --- a/doc/development_guide/contributor_guide/release.md +++ b/doc/development_guide/contributor_guide/release.md @@ -12,8 +12,8 @@ the maintenance branch. If so, release a last patch release first. See date. - Remove the empty changelog for the last unreleased patch version `X.Y-1.Z'`. (For example: `v2.3.5`) -- Check the result of `git diff vX.Y-1.Z' ChangeLog`. (For example: - `git diff v2.3.4 ChangeLog`) +- Check the result of `git diff vX.Y-1.Z' doc/whatsnew`. (For example: + `git diff v2.3.4 doc/whatsnew`) - Install the release dependencies: `pip3 install -r requirements_test.txt` - Bump the version and release by using `tbump X.Y.0 --no-push --no-tag`. (For example: `tbump 2.4.0 --no-push --no-tag`) @@ -65,8 +65,8 @@ maintenance branch we cherry-pick the commit from `main`. We release patch versions when a crash or a bug is fixed on the main branch and has been cherry-picked on the maintenance branch. -- Check the result of `git diff vX.Y-1.Z-1 ChangeLog`. (For example: - `git diff v2.3.4 ChangeLog`) +- Check the result of `git diff vX.Y-1.Z-1 doc/whatsnew`. (For example: + `git diff v2.3.4 doc/whatsnew`) - Install the release dependencies: `pip3 install -r requirements_test.txt` - Bump the version and release by using `tbump X.Y-1.Z --no-push`. (For example: `tbump 2.3.5 --no-push`) diff --git a/doc/whatsnew/2/2.14/full.rst b/doc/whatsnew/2/2.14/full.rst index ea666ead8..46ec8037c 100644 --- a/doc/whatsnew/2/2.14/full.rst +++ b/doc/whatsnew/2/2.14/full.rst @@ -6,7 +6,7 @@ What's New in Pylint 2.14.0? Release date: TBA -* The refactoring checker now also raises 'consider-using-a-generator' messages for +* The refactoring checker now also raises 'consider-using-generator' messages for ``max()``, ``min()`` and ``sum()``. Refs #6595 diff --git a/doc/whatsnew/2/2.3/summary.rst b/doc/whatsnew/2/2.3/summary.rst index d30f9b11b..973736577 100644 --- a/doc/whatsnew/2/2.3/summary.rst +++ b/doc/whatsnew/2/2.3/summary.rst @@ -29,7 +29,7 @@ Other Changes ============= Quite a lot of bug fixes and improvements went into this release, here's a handful of them. -For the full changes, check the Changelog. +For the full changes, check the full changelog. * We no longer emit ``*-not-iterating`` checks for builtins consumed by ``itertools`` diff --git a/script/bump_changelog.py b/script/bump_changelog.py index fca874699..33a264fa1 100644 --- a/script/bump_changelog.py +++ b/script/bump_changelog.py @@ -16,6 +16,7 @@ import logging from datetime import datetime from pathlib import Path +# TODO: 2.14.0 Upgrade bump script DEFAULT_CHANGELOG_PATH = Path("ChangeLog") RELEASE_DATE_TEXT = "Release date: TBA" diff --git a/script/fix_documentation.py b/script/fix_documentation.py index e248f0646..35eed9aff 100644 --- a/script/fix_documentation.py +++ b/script/fix_documentation.py @@ -14,6 +14,7 @@ INVALID_CODE_BLOCK_PATTERN = ( r"(?<=\s`)([\w\-\.\(\)\=]+\s{0,1}[\w\-\.\(\)\=]*)(?=`[,\.]{0,1}\s|$)" ) +# TODO: 2.14.0: Upgrade script for change in changelog DEFAULT_CHANGELOG = "ChangeLog" DEFAULT_SUBTITLE_PREFIX = "What's New in" |