Skip to content

Commit

Permalink
docs: document breaking changes for #2476 into migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewmayer committed Jun 4, 2024
1 parent badaa6d commit f4aef77
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
15 changes: 14 additions & 1 deletion docs/guide/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 organized under `definitions.location.direction` and `definitions.location.direction_abbr` and where 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`.

Expand Down
12 changes: 0 additions & 12 deletions docs/guide/upgrading_v9/2476.md

This file was deleted.

0 comments on commit f4aef77

Please sign in to comment.