aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2024-06-26 09:42:15 +0200
committerGitHub <[email protected]>2024-06-26 07:42:15 +0000
commit49d7119025d252eecb043647b7d4465352938157 (patch)
treee3ac034ac5e2ee635eb80ac30a7440ace3b42856 /docs
parent8134b336f3c270126b5f8af9f18a7e7563c104bd (diff)
downloadfaker-49d7119025d252eecb043647b7d4465352938157.tar.xz
faker-49d7119025d252eecb043647b7d4465352938157.zip
refactor(locale): rename company affix files (#2975)
Diffstat (limited to 'docs')
-rw-r--r--docs/guide/upgrading.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md
index beccc457..82148296 100644
--- a/docs/guide/upgrading.md
+++ b/docs/guide/upgrading.md
@@ -183,6 +183,21 @@ Removed deprecated company methods
| `faker.company.bsBuzz` | `faker.company.buzzVerb` |
| `faker.company.bsNoun` | `faker.company.buzzNoun` |
+#### Company Name Affix files reorganized
+
+The company name affix files have been used inconsistently.
+Sometimes `suffix`es were used as prefixes in the patterns, because they contained legal entity types (and in English these were defined as `suffix`es).
+We renamed the files to match their actual content instead of their hypothetical position.
+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.company.prefix` | `location.company.category` |
+| `location.company.suffix` | `location.direction.legal_entity_type` |
+
+Note: In some locales `prefix`es and `suffix`es might have been swapped, so the mapping might be wrong for those.
+
### Datatype Module
Removed deprecated datatype methods