Better documentation on the packaging breaking changes

Closes #4399
pylint-dev · Apr 25, 2021 · f5eb153 · f5eb153
1 parent 45b4fbd
commit f5eb153
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -46,7 +46,7 @@ Release date: 2021-04-24
 * The 'doc' extra-require has been removed.
 
 * ``__pkginfo__`` now only contain ``__version__`` (also accessible with ``pylint.__version__``), other meta-information are still
-  accessible with ``import importlib;metadata.metadata('pylint')``.
+  accessible with ``from importlib import metadata;metadata.metadata('pylint')``.
 
 * COPYING has been renamed to LICENSE for standardization.
 

diff --git a/doc/whatsnew/2.8.rst b/doc/whatsnew/2.8.rst
@@ -8,6 +8,16 @@
 Summary -- Release highlights
 =============================
 
+Breaking changes
+================
+
+* The 'doc' extra-require has been removed. ``pylint.version`` is now ``pylint.__version__`` and ``__pkginfo__`` does
+  not contain the package metadata anymore. Meta-information are still accessible with
+
+```python
+from importlib import metadata
+metadata.metadata('pylint')
+```
 
 New checkers
 ============
@@ -43,9 +53,6 @@ Other Changes
 * The packaging is now done via setuptools exclusively. ``doc``, ``tests``, ``man``, ``elisp`` and ``Changelog`` are
   not packaged anymore - reducing the size of the package by 75%.
 
-* The 'doc' extra-require has been removed. ``pylint.version`` is now ``pylint.__version__`` and ``__pkginfo__`` does
-  not contain the package metadata anymore.
-
 * Updated ``astroid`` to 2.5.4
 
 * COPYING has been renamed to LICENSE for standardization.