Skip to content

Commit f0fdecd

Browse files
committed
Add missing docs and make them similar
1 parent d5f744a commit f0fdecd

35 files changed

+101
-113
lines changed

doc/books/dune.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ Faker::Books::Dune.planet #=> "Caladan"
1111

1212
Faker::Books::Dune.quote #=> "A dead man, surely, no longer requires that water."
1313

14+
# Keyword arguments: character
1415
Faker::Books::Dune.quote(character: "baron_harkonnen") #=> "He who controls the spice, controls the universe!"
1516

1617
Faker::Books::Dune.saying #=> "You do not beg the sun for mercy."
1718

19+
# Keyword arguments: source
1820
Faker::Books::Dune.saying(source: "fremen") #=> "May thy knife chip and shatter."
1921
```

doc/books/lovecraft.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,30 @@ Faker::Books::Lovecraft.location #=> "Kingsport"
1212

1313
Faker::Books::Lovecraft.word #=> "furtive"
1414

15-
# Keyword arguments: word_count: 4, random_words_to_add: 6
15+
# Keyword arguments: word_count, random_words_to_add
1616
Faker::Books::Lovecraft.sentence #=> "Furtive antiquarian squamous dank cat loathsome amorphous lurk."
1717
Faker::Books::Lovecraft.sentence(word_count: 3) #=> "Daemoniac antediluvian fainted squamous comprehension gambrel nameless singular."
1818
Faker::Books::Lovecraft.sentence(word_count: 3, random_words_to_add: 1) #=> "Amorphous indescribable tenebrous."
1919

20-
# Keyword arguments: number: 3, spaces_allowed: false
20+
# Keyword arguments: number, spaces_allowed
2121
Faker::Books::Lovecraft.words #=> ["manuscript", "abnormal", "singular"]
2222
Faker::Books::Lovecraft.words(number: 2) #=> ["daemoniac", "cat"]
2323
Faker::Books::Lovecraft.words(number: 2, spaces_allowed: true) #=> ["lurk", "charnel"]
2424

25-
# Keyword arguments: number: 3
25+
# Keyword arguments: number
2626
Faker::Books::Lovecraft.sentences #=> ["Nameless loathsome decadent gambrel.", "Ululate swarthy immemorial cat madness gibbous unmentionable unnamable.", "Decadent antediluvian non-euclidean tentacles amorphous tenebrous."]
2727
Faker::Books::Lovecraft.sentences(number: 2) #=> ["Antediluvian amorphous unmentionable singular accursed squamous immemorial.", "Gambrel daemoniac gibbous stygian shunned ululate iridescence abnormal."]
2828

29-
# Keyword arguments: sentence_count: 3, random_sentences_to_add: 3
29+
# Keyword arguments: sentence_count, random_sentences_to_add
3030
Faker::Books::Lovecraft.paragraph #=> "Squamous nameless daemoniac fungus ululate. Cyclopean stygian decadent loathsome manuscript tenebrous. Foetid abnormal stench. Dank non-euclidean comprehension eldritch. Charnel singular shunned lurk effulgence fungus."
3131
Faker::Books::Lovecraft.paragraph(sentence_count: 2) #=> "Decadent lurk tenebrous loathsome furtive spectral amorphous gibbous. Gambrel eldritch daemoniac cat madness comprehension stygian effulgence."
3232
Faker::Books::Lovecraft.paragraph(sentence_count: 2, random_sentences_to_add: 1) #=> "Stench cyclopean fainted antiquarian nameless. Antiquarian ululate tenebrous non-euclidean effulgence."
3333

34-
# Keyword arguments: number: 3
34+
# Keyword arguments: number
3535
Faker::Books::Lovecraft.paragraphs #=> ["Noisome daemoniac gibbous abnormal antediluvian. Unutterable fungus accursed stench noisome lurk madness indescribable. Antiquarian fungus gibbering lurk dank fainted. Hideous loathsome manuscript daemoniac lurk charnel foetid.", "Non-euclidean immemorial indescribable accursed furtive. Dank unnamable cyclopean tenebrous stench immemorial. Eldritch abnormal gibbering tenebrous. Singular accursed lurk.", "Charnel antediluvian unnamable cat blasphemous comprehension tenebrous. Nameless accursed amorphous unnamable stench. Squamous unnamable mortal accursed manuscript spectral gambrel amorphous. Shunned stygian charnel unutterable. Tenebrous ululate lurk amorphous unnamable."]
3636
Faker::Books::Lovecraft.paragraphs(number: 2) #=> ["Hideous amorphous manuscript antediluvian non-euclidean cat eldritch foetid. Stench squamous manuscript amorphous gibbering fainted gibbous. Accursed loathsome blasphemous iridescence antediluvian abnormal ululate manuscript. Singular manuscript gibbering decadent accursed indescribable.", "Tenebrous unnamable comprehension antediluvian lurk. Lurk spectral noisome gibbering. Furtive manuscript madness tenebrous daemoniac."]
3737

38-
# Keyword arguments: characters: 3, supplemental: false
38+
# Keyword arguments: characters, supplemental
3939
Faker::Books::Lovecraft.paragraph_by_chars #=> "Truffaut stumptown trust fund 8-bit messenger bag portland. Meh kombucha selvage swag biodiesel. Lomo kinfolk jean shorts asymmetrical diy. Wayfarers portland twee stumptown. Wes anderson biodiesel retro 90's pabst. Diy echo 90's mixtape semiotics. Cornho."
4040
Faker::Books::Lovecraft.paragraph_by_chars(characters: 256) #=> "Hella kogi blog narwhal sartorial selfies mustache schlitz. Bespoke normcore kitsch cred hella fixie. Park aesthetic fixie migas twee. Cliche mustache brunch tumblr fixie godard. Drinking pop-up synth hoodie dreamcatcher typewriter. Kitsch biodiesel green."
4141
```

doc/default/alphanumeric.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Faker::Alphanumeric
22

33
```ruby
4+
# Keyword arguments: characters
45
Faker::Alphanumeric.alpha(characters: 10) #=> "zlvubkrwga"
56

7+
# Keyword arguments: characters
68
Faker::Alphanumeric.alphanumeric(characters: 10) #=> "3yfq2phxtb"
79
```

doc/default/bank.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33

44
Faker::Bank.account_number #=> 6738582379
55

6+
# Keyword arguments: digits
67
Faker::Bank.account_number(digits: 13) #=> 673858237902
78

89
Faker::Bank.iban #=> "GB76DZJM33188515981979"
910

10-
# Keyword argument: country_code
11+
# Keyword arguments: country_code
1112
# All countries should be supported
1213
Faker::Bank.iban(country_code: "be") #=> "BE6375388567752043"
1314

doc/default/boolean.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ Available since version 1.6.2.
55
```ruby
66
Faker::Boolean.boolean #=> true
77

8-
# Keyword parameter: true_ratio: 0.5
8+
# Keyword parameter: true_ratio
99
Faker::Boolean.boolean(true_ratio: 0.2) #=> false
1010
```

doc/default/chile_rut.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Faker::ChileRut.full_rut #=> "30686957-4"
77
Faker::ChileRut.rut #=> 11235813
88

99
# Returns rut between passed minimum rut and 99999999
10+
# Keyword arguments: min_rut
1011
Faker::ChileRut.rut(min_rut: 20_890_156) #=> 31853211
1112

1213
# Every call to rut or full_rut generates a new random rut, so last_rut and dv

doc/default/code.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Faker::Code.rut #=> "91389184-8"
1111

1212
Faker::Code.nric #=> "S5589083H"
1313

14+
# Keyword arguments: min_age, max_age
1415
Faker::Code.nric(min_age: 27, max_age: 34) #=> S8505970Z
1516

1617
Faker::Code.imei #= "546327785982623"

doc/default/commerce.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
```ruby
44
Faker::Commerce.color #=> "lavender"
55

6-
# Keyword arguments max: 3, fixed_amount: false
6+
# Keyword arguments: max, fixed_amount
77
Faker::Commerce.department #=> "Grocery, Health & Beauty"
88
Faker::Commerce.department(max: 5) #=> "Grocery, Books, Health & Beauty"
99
Faker::Commerce.department(max: 2, fixed_amount: true) #=> "Books & Tools"
@@ -13,11 +13,12 @@ Faker::Commerce.material #=> "Steel"
1313
Faker::Commerce.product_name #=> "Practical Granite Shirt"
1414

1515
# Produces a Float by default
16+
# Keyword arguments: range, as_string
1617
Faker::Commerce.price #=> 44.6
1718
Faker::Commerce.price(range: 0..10.0, as_string: true) #=> "2.18"
1819

1920
# Generate a random promotion code.
20-
# Keyword argument digits: 6 for number of random digits in suffix
21+
# Keyword arguments: digits
2122
Faker::Commerce.promotion_code #=> "AmazingDeal829102"
2223
Faker::Commerce.promotion_code(digits: 2) #=> "AmazingPrice57"
2324

doc/default/company.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Faker::Company.south_african_trust_registration_number #=> "IT38/6489900"
7070
Faker::Company.brazilian_company_number #=> "18553414000618"
7171

7272
# Get a random formatted Brazilian company number (CNPJ)
73+
# Keyword arguments: formatted
7374
Faker::Company.brazilian_company_number(formatted: true) #=> "00.000.000/0000-00"
7475

7576
# Get a random USA Standard Industrial Classification code (SIC)

doc/default/date.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,22 @@
22

33
```ruby
44
# Random date between dates
5+
# Keyword arguments: from, to
56
Faker::Date.between(from: 2.days.ago, to: Date.today) #=> "Wed, 24 Sep 2014"
67

78
# Random date between dates except for certain date
9+
# Keyword arguments: from, to, excepted
810
Faker::Date.between_except(from: 1.year.ago, to: 1.year.from_now, excepted: Date.today) #=> "Wed, 24 Sep 2014"
911

1012
# Random date in the future (up to maximum of N days)
13+
# Keyword arguments: days
1114
Faker::Date.forward(days: 23) # => "Fri, 03 Oct 2014"
1215

1316
# Random date in the past (up to maximum of N days)
17+
# Keyword arguments: days
1418
Faker::Date.backward(days: 14) #=> "Fri, 19 Sep 2014"
1519

1620
# Random birthday date (maximum age between 18 and 65)
21+
# Keyword arguments: min_age, max_age
1722
Faker::Date.birthday(min_age: 18, max_age: 65) #=> "Mar, 28 Mar 1986"
1823
```

0 commit comments

Comments
 (0)