From a69755704f402a36cffe18830c5d0899d2e1324c Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sat, 28 May 2022 09:32:49 +0200 Subject: [doc] Add an explanation on versionning scheme in the FAQ Closes #6676 --- doc/user_guide/installation/index.rst | 1 + doc/user_guide/installation/upgrading_pylint.rst | 26 ++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 doc/user_guide/installation/upgrading_pylint.rst (limited to 'doc/user_guide') diff --git a/doc/user_guide/installation/index.rst b/doc/user_guide/installation/index.rst index 7c764fcfc..806f74889 100644 --- a/doc/user_guide/installation/index.rst +++ b/doc/user_guide/installation/index.rst @@ -16,3 +16,4 @@ Pylint can be installed: ide_integration/index pre-commit-integration.rst badge + upgrading_pylint.rst diff --git a/doc/user_guide/installation/upgrading_pylint.rst b/doc/user_guide/installation/upgrading_pylint.rst new file mode 100644 index 000000000..08cbef770 --- /dev/null +++ b/doc/user_guide/installation/upgrading_pylint.rst @@ -0,0 +1,26 @@ +.. _upgrading_pylint: + +Upgrading pylint +================ + +You should probably set the version of pylint in your development environment in order to +choose when you actually upgrade pylint's warnings. pylint is following semver versioning. +But we can't guarantee that the output between version will stays the same. What this means +is that: + +.. include:: ../../development_guide/contributor_guide/patch_release.rst + +You can expect less messages if you set the minor and upgrade to a new patch version. +But still, if you enable ``useless-suppression`` it still means you can get a new +``useless-suppression`` when a false positive that you disabled is now fixed. Also, +if a library you're using was upgraded and is understood better or worse than the +previous one, you could get new messages too. + +.. include:: ../../development_guide/contributor_guide/minor_release.rst + +You can expect a lot more change in output, the main one being new checks. + +.. include:: ../../development_guide/contributor_guide/major_release.rst + +You could have to change the command you're launching or the plugin and +editor integration you're using. -- cgit v1.2.1