Merge pull request #234 from maxmind/greg/eng-1001-mark-metro-code-data-as-deprecated-in-our-libraries

Deprecate metro code

Author: horgh

CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+3.2.0
+------------------
+
+* `metroCode` on `GeoIp2\Record\Location` has been deprecated. The code
+  values are no longer being maintained.
+
 3.1.0 (2024-11-15)
 ------------------
 
@@ -15,7 +21,7 @@ CHANGELOG
 * IMPORTANT: PHP 8.1 or greater is now required.
 * BREAKING: Read-only properties are now used for the model and record
   classes rather than magic methods. This significantly improves performance.
-* BREAKING: The `raw` property on model classess and the `record` property on
+* BREAKING: The `raw` property on model classes and the `record` property on
   record classes have been removed.
 * BREAKING: On `GeoIp2\Record\Traits`, the deprecated `isAnonymousProxy` and
   `isSatelliteProvider` properties have been removed.

src/Record/Location.php

@@ -43,10 +43,10 @@ class Location implements \JsonSerializable
     public readonly ?float $longitude;
 
     /**
-     * @var int|null The metro code of the location if the location
-     *               is in the US. MaxMind returns the same metro codes as the
-     *               Google AdWords API. See
-     *               https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions.
+     * @var int|null the metro code is a no-longer-maintained code for targeting
+     *               advertisements in Google
+     *
+     * @deprecated
      */
     public readonly ?int $metroCode;