Improve reference checkign

alexrudy · alexrudy · commit 8f37c92e3f5a · 2019-08-03T10:42:25.000-07:00
diff --git a/doc/missing-references.json b/doc/missing-references.json
@@ -373,15 +373,15 @@
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.contourf:133"
     ],
     "P_{xy}": [
-      "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.csd:168",
+      "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.csd:167",
       "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.csd:89",
       "lib/matplotlib/mlab.py:docstring of matplotlib.mlab.csd:79",
-      "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.csd:168",
+      "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.csd:167",
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.csd:89"
     ],
     "Lines2D": [
-      "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.errorbar:105",
-      "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.errorbar:105"
+      "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.errorbar:103",
+      "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.errorbar:103"
     ],
     "fmt_xdata": [
       "lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.format_xdata:4"
@@ -1473,6 +1473,11 @@
     "Locator.view_limits()": [
       "doc/api/next_api_changes/2019-02-19-AL.rst:4"
     ],
+    "MovieWriterRegistry": [
+      "doc/api/next_api_changes/2019-03-03-AL.rst:10",
+      "doc/api/next_api_changes/2019-03-03-AL.rst:4",
+      "doc/api/prev_api_changes/api_changes_2.2.0.rst:158"
+    ],
     "Axes.add_line": [
       "doc/api/next_api_changes/2019-03-04-AL.rst:9"
     ],
@@ -1551,6 +1556,9 @@
     "imshow(A, interpolation='antialiased')": [
       "doc/api/next_api_changes/2019-07-17-JMK.rst:8"
     ],
+    "SymLogScale": [
+      "doc/api/next_api_changes/2019-07-24-AL.rst:4"
+    ],
     "api_changes.rst": [
       "doc/api/next_api_changes/README.rst:6"
     ],
@@ -2471,9 +2479,6 @@
     "fontd": [
       "doc/api/prev_api_changes/api_changes_2.2.0.rst:110"
     ],
-    "MovieWriterRegistry": [
-      "doc/api/prev_api_changes/api_changes_2.2.0.rst:158"
-    ],
     "MovieWriter": [
       "doc/api/prev_api_changes/api_changes_2.2.0.rst:158"
     ],
diff --git a/doc/sphinxext/missing_references.py b/doc/sphinxext/missing_references.py
@@ -129,6 +129,18 @@ def get_location(node, app):
     return f"{path}:{line}"
 
 
+def _truncate_location(location):
+    """
+    Cuts off anything after the first colon in location strings.
+
+    This allows for easy comparison even when line numbers chagne
+    (as they do regularily).
+    """
+    if ":" in location:
+        return location.split(":", 1)[0]
+    return location
+
+
 def _warn_unused_missing_references(app):
     if not app.config.missing_references_warn_unused_ignores:
         return
@@ -148,13 +160,14 @@ def _warn_unused_missing_references(app):
 
     # Warn about any reference which is no longer missing.
     for (domain_type, target), locations in references_ignored.items():
-        missing_reference_locations = references_events.get(
-                (domain_type, target), [])
+        missing_reference_locations = [_truncate_location(location)
+            for location in references_events.get((domain_type, target), [])]
 
         # For each ignored reference location, ensure a missing reference
         # was observed. If it wasn't observed, issue a warning.
         for ignored_reference_location in locations:
-            if ignored_reference_location not in missing_reference_locations:
+            short_location = _truncate_location(ignored_reference_location)
+            if short_location not in missing_reference_locations:
                 msg = (f"Reference {domain_type} {target} for "
                        f"{ignored_reference_location} can be removed"
                        f" from {app.config.missing_references_filename}."
