docs: clean up for #1610. Thanks, Brian Grohe.

nedbat · Apr 25, 2023 · d6e621a · d6e621a
1 parent c6610b3
commit d6e621a
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 6 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -20,8 +20,11 @@ development at the same time, such as 4.5.x and 5.0.
 Unreleased
 ----------
 
-Nothing yet.
+- Docs: a new :ref:`Migrating page <migrating>` with details about how to
+  migrate between major versions of coverage.py.  It currently covers the
+  wildcard changes in 7.x.  Thanks, `Brian Grohe <pull 1610_>`_.
 
+.. _pull 1610: https://github.com/nedbat/coveragepy/pull/1610
 
 .. scriv-start-here
 

diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -32,6 +32,7 @@ Bill Hart
 Bradley Burns
 Brandon Rhodes
 Brett Cannon
+Brian Grohe
 Bruno P. Kinoshita
 Buck Evan
 Calen Pennington

diff --git a/doc/index.rst b/doc/index.rst
@@ -234,5 +234,5 @@ More information
     trouble
     faq
     Change history <changes>
-    Migrating version notes <migrations>
+    migrating
     sleepy
diff --git a/doc/migrations.rst → doc/migrating.rst b/doc/migrations.rst → doc/migrating.rst
@@ -1,18 +1,21 @@
 .. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
 .. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt
 
-.. _migrations:
+.. _migrating:
 
 ==========================
 Migrating between versions
 ==========================
 
+New major versions of coverage.py might require you to adjust your settings,
+options, or other aspects of your use.  This page details those changes.
+
 .. _migrating_6x_7x:
 
-Migrating 6.5.x — 7.0.x
------------------------
+Migrating from 6.x to 7.x
+-------------------------
 
-- The way that wildcards when specifying file paths work in certain cases has changed in 7.0.x:
+- The way that wildcards when specifying file paths work in certain cases has changed in 7.x:
 
   - Previously, ``*`` would incorrectly match directory separators, making
     precise matching difficult. Patterns such as ``*tests/*``