docs: merge migration guide snippet (faker-js#2935)

eLoyyyyy · Oct 14, 2024 · 9213574 · 9213574
1 parent 8b6ae6d
commit 9213574
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 13 deletions.
diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md
@@ -424,7 +424,20 @@ Removed deprecated location methods
 | `faker.location.ordinalDirection(abbreviated)`                     | `faker.location.ordinalDirection({ abbreviated })`                 |
 | `faker.location.nearbyGPSCoordinate(coordinate, radius, isMetric)` | `faker.location.nearbyGPSCoordinate({ origin, radius, isMetric })` |
 
-#### Removed Definitions
+#### Direction definitions reorganized
+
+The locale definitions used by `faker.location.direction()`, `faker.location.cardinalDirection()` and `faker.location.ordinalDirection()` have been reorganized.
+Previously, they were located under `definitions.location.direction` and `definitions.location.direction_abbr` and their values were required to be in a specific order.
+Now, all values are nested under `definitions.location.direction` with descriptive property names.
+If you are using the public methods, no changes are required.
+You only need to change your code if you are accessing the raw definitions e.g. in `faker.helpers.fake()`.
+
+| Before                    | After                                                                   |
+| ------------------------- | ----------------------------------------------------------------------- |
+| `location.direction`      | `location.direction.cardinal` or `location.direction.ordinal`           |
+| `location.direction_abbr` | `location.direction.cardinal_abbr` or `location.direction.ordinal_abbr` |
+
+#### Default country definitions removed
 
 The `faker.definitions.location.default_country` definition has been removed, as they were not used by any public method, and were not useful for locales which don't correspond directly to a single country, like `ar`.
 

diff --git a/docs/guide/upgrading_v9/2476.md b/docs/guide/upgrading_v9/2476.md