Skip to content

Commit 22a019e

Browse files
authored
fix: formatting and update examples in README
Updated README to correct formatting and clarify examples.
1 parent 1853d99 commit 22a019e

1 file changed

Lines changed: 26 additions & 19 deletions

File tree

README.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -163,22 +163,22 @@ Schema<Name, String> fromScratch =
163163
field("lastname", () -> faker.name().lastName()));
164164
System.out.println(transformer.generate(fromScratch, 2));
165165
// POSSIBLE OUTPUT
166-
// "first_name" ; "last_name"
167-
// "Kimberely" ; "Considine"
168-
// "Mariela" ; "Krajcik"
166+
// "firstName","lastname"
167+
// "Kimberely","Considine"
168+
// "Mariela","Krajcik"
169169
// ----------------------
170170
// Schema for transformations
171171
Schema<Name, String> schemaForTransformations =
172172
Schema.of(field("firstName", Name::firstName),
173173
field("lastname", Name::lastName));
174-
// Here we pass a collection of Name objects and extract first and lastnames from each element
174+
// Here we pass a collection of Name objects and extract first and last names from each element
175175
System.out.println(
176176
transformer.generate(
177177
faker.collection(faker::name).maxLen(2).generate(), schemaForTransformations));
178178
// POSSIBLE OUTPUT
179-
// "first_name" ; "last_name"
180-
// "Kimberely" ; "Considine"
181-
// "Mariela" ; "Krajcik"
179+
// "firstName","lastname"
180+
// "Kimberely","Considine"
181+
// "Mariela","Krajcik"
182182
```
183183

184184
#### JShell
@@ -208,7 +208,7 @@ jshell> Schema fromScratch =
208208
fromScratch ==> net.datafaker.transformations.Schema@306a30c7
209209
210210
jshell> CsvTransformer<Name> transformer =
211-
...> CsvTransformer.<Name>builder().header(false).separator(",").build();
211+
...> CsvTransformer.<Name>builder().header(true).separator(",").build();
212212
transformer ==> net.datafaker.transformations.CsvTransformer@506c589e
213213
214214
jshell> System.out.println(transformer.generate(fromScratch, 2));
@@ -439,21 +439,28 @@ The list below is not complete and shows only a part of available providers. To
439439
* Slack Emoji
440440
* Soul Knight
441441
* Space
442-
* StarCraft
443-
* StarTrek
442+
* Star Craft
443+
* Star Trek
444+
* Star Wars
444445
* Stock
445446
* Studio Ghibli
446447
* Subscription
447448
* Super Mario
448449
* Superhero
449450
* Tea
450451
* Team
452+
* The Expanse
451453
* The IT Crowd
454+
* The Kingkiller Chronicle
455+
* The Matrix
456+
* The Room
457+
* The Thick Of It
458+
* The Venture Bros
452459
* Time
460+
* Tormenta
453461
* Touhou
454462
* Tron
455463
* Twin Peaks
456-
* Tormenta
457464
* Twitter
458465
* University
459466
* Vehicle
@@ -468,32 +475,32 @@ Usage with Locales
468475
-----
469476

470477
```java
471-
Faker faker = new Faker(new Locale("lang", "COUNTRY"));
478+
Faker faker = new Faker(Locale.of("lang", "COUNTRY"));
472479
```
473480

474481
For example:
475482

476483
```java
477-
String californiaZipCode = new Faker(new Locale("en", "US")).address().zipCodeByState("CA");
478-
String albanianIdNumber = new Faker(new Locale("sq", "AL")).idNumber().valid();
479-
String moldovanPhone = new Faker(new Locale("ru", "MD")).phoneNumber().cellPhone();
484+
String californiaZipCode = new Faker(Locale.of("en", "US")).address().zipCodeByState("CA");
485+
String albanianIdNumber = new Faker(Locale.of("sq", "AL")).idNumber().valid();
486+
String moldovanPhone = new Faker(Locale.of("ru", "MD")).phoneNumber().cellPhone();
480487
```
481488

482489
Note that most of the data depends on language,
483490
but some data depends purely on country (personal ID and phone numbers).
484491
In the example above,
485492
* "en", "sq", "ru" are language codes (English, Albanian and Russian), and
486-
* "US", "AL", "MD" are country codes (USA, Albanian and Moldova)
493+
* "US", "AL", "MD" are country codes (USA, Albania and Moldova)
487494

488495
<details>
489496
<summary>Supported Locales</summary>
490497

491498
-----
492-
* ar (Armenian)
499+
* ar (Arabic)
493500
* be_BY (Belarusian)
494501
* bg_BG (Bulgarian)
495-
* ca_CA (Canada)
496-
* ca-CAT
502+
* ca (Catalan)
503+
* ca-CAT (language: Catalan, country: Catalonia)
497504
* cs_CZ (Czech republic)
498505
* da-DK (language: Danish, country: Denmark)
499506
* de (German)

0 commit comments

Comments
 (0)