docs(location): clarify city and cityName methods (#1621)

faker-js · Dec 2, 2022 · 5e51335 · 5e51335
1 parent 0cec571
commit 5e51335
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/modules/location/index.ts b/src/modules/location/index.ts
@@ -66,10 +66,11 @@ export class LocationModule {
   }
 
   /**
-   * Generates a random localized city name.
+   * Generates a random fictional city name for the locale.
    *
    * @example
    * faker.location.city() // 'East Jarretmouth'
+   * faker.locale = 'de'; faker.location.city() // 'Bad Lilianadorf'
    *
    * @since 8.0.0
    */
@@ -81,10 +82,11 @@ export class LocationModule {
   }
 
   /**
-   * Returns a random localized and existing city name.
+   * Returns a random city name from a list of real cities for the locale.
    *
    * @example
    * faker.location.cityName() // 'San Rafael'
+   * faker.locale = 'de'; faker.location.cityName() // 'Nürnberg'
    *
    * @since 8.0.0
    */