Merge pull request #186 from maxmind/greg/eng-1001-mark-metro-code-da…

…ta-as-deprecated-in-our-libraries Deprecate metro code
maxmind · Jan 13, 2025 · 963cd22 · 963cd22
2 parents 4c69881 + 2b00011
commit 963cd22
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -4,6 +4,12 @@
 History
 -------
 
+4.9.0
+++++++++++++++++++
+
+* ``metro_code`` on ``geoip2.record.Location`` has been deprecated. The
+  code values are no longer being maintained.
+
 4.8.1 (2024-11-18)
 ++++++++++++++++++
 

diff --git a/geoip2/records.py b/geoip2/records.py
@@ -357,10 +357,10 @@ class Location(Record):
 
     .. attribute:: metro_code
 
-      The metro code of the location if the
-      location is in the US. MaxMind returns the same metro codes as the
-      `Google AdWords API
-      <https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions>`_.
+      The metro code is a no-longer-maintained code for targeting
+      advertisements in Google.
+
+      .. deprecated:: 4.9.0
 
       :type: int
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,12 @@ @@
     History
     -------
+.9.0
+    ++++++++++++++++++
+    * ``metro_code`` on ``geoip2.record.Location`` has been deprecated. The
+      code values are no longer being maintained.
 .8.1 (2024-11-18)
     ++++++++++++++++++
@@ Expand Down @@