Add missing docs and make them similar

Author: vbrazo

doc/books/dune.md

@@ -11,9 +11,11 @@ Faker::Books::Dune.planet #=> "Caladan"
 
 Faker::Books::Dune.quote #=> "A dead man, surely, no longer requires that water."
 
+# Keyword arguments: character
 Faker::Books::Dune.quote(character: "baron_harkonnen") #=> "He who controls the spice, controls the universe!"
 
 Faker::Books::Dune.saying #=> "You do not beg the sun for mercy."
 
+# Keyword arguments: source
 Faker::Books::Dune.saying(source: "fremen") #=> "May thy knife chip and shatter."
 ```

doc/books/lovecraft.md

@@ -12,30 +12,30 @@ Faker::Books::Lovecraft.location #=> "Kingsport"
 
 Faker::Books::Lovecraft.word #=> "furtive"
 
-# Keyword arguments: word_count: 4, random_words_to_add: 6
+# Keyword arguments: word_count, random_words_to_add
 Faker::Books::Lovecraft.sentence #=> "Furtive antiquarian squamous dank cat loathsome amorphous lurk."
 Faker::Books::Lovecraft.sentence(word_count: 3) #=> "Daemoniac antediluvian fainted squamous comprehension gambrel nameless singular."
 Faker::Books::Lovecraft.sentence(word_count: 3, random_words_to_add: 1) #=> "Amorphous indescribable tenebrous."
 
-# Keyword arguments: number: 3, spaces_allowed: false
+# Keyword arguments: number, spaces_allowed
 Faker::Books::Lovecraft.words #=> ["manuscript", "abnormal", "singular"]
 Faker::Books::Lovecraft.words(number: 2) #=> ["daemoniac", "cat"]
 Faker::Books::Lovecraft.words(number: 2, spaces_allowed: true) #=> ["lurk", "charnel"]
 
-# Keyword arguments: number: 3
+# Keyword arguments: number
 Faker::Books::Lovecraft.sentences #=> ["Nameless loathsome decadent gambrel.", "Ululate swarthy immemorial cat madness gibbous unmentionable unnamable.", "Decadent antediluvian non-euclidean tentacles amorphous tenebrous."]
 Faker::Books::Lovecraft.sentences(number: 2) #=> ["Antediluvian amorphous unmentionable singular accursed squamous immemorial.", "Gambrel daemoniac gibbous stygian shunned ululate iridescence abnormal."]
 
-# Keyword arguments: sentence_count: 3, random_sentences_to_add: 3
+# Keyword arguments: sentence_count, random_sentences_to_add
 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."
 Faker::Books::Lovecraft.paragraph(sentence_count: 2) #=> "Decadent lurk tenebrous loathsome furtive spectral amorphous gibbous. Gambrel eldritch daemoniac cat madness comprehension stygian effulgence."
 Faker::Books::Lovecraft.paragraph(sentence_count: 2, random_sentences_to_add: 1) #=> "Stench cyclopean fainted antiquarian nameless. Antiquarian ululate tenebrous non-euclidean effulgence."
 
-# Keyword arguments: number: 3
+# Keyword arguments: number
 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."]
 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."]
 
-# Keyword arguments: characters: 3, supplemental: false
+# Keyword arguments: characters, supplemental
 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."
 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."
 ```

doc/default/alphanumeric.md

@@ -1,7 +1,9 @@
 # Faker::Alphanumeric
 
 ```ruby
+# Keyword arguments: characters
 Faker::Alphanumeric.alpha(characters: 10) #=> "zlvubkrwga"
 
+# Keyword arguments: characters
 Faker::Alphanumeric.alphanumeric(characters: 10) #=> "3yfq2phxtb"
 ```

doc/default/bank.md

@@ -3,11 +3,12 @@
 
 Faker::Bank.account_number #=> 6738582379
 
+# Keyword arguments: digits
 Faker::Bank.account_number(digits: 13) #=> 673858237902
 
 Faker::Bank.iban #=> "GB76DZJM33188515981979"
 
-# Keyword argument: country_code
+# Keyword arguments: country_code
 # All countries should be supported
 Faker::Bank.iban(country_code: "be") #=> "BE6375388567752043"
 

doc/default/boolean.md

@@ -5,6 +5,6 @@ Available since version 1.6.2.
 ```ruby
 Faker::Boolean.boolean #=> true
 
-# Keyword parameter: true_ratio: 0.5
+# Keyword parameter: true_ratio
 Faker::Boolean.boolean(true_ratio: 0.2) #=> false
 ```

doc/default/chile_rut.md

@@ -7,6 +7,7 @@ Faker::ChileRut.full_rut #=> "30686957-4"
 Faker::ChileRut.rut #=> 11235813
 
 # Returns rut between passed minimum rut and 99999999
+# Keyword arguments: min_rut
 Faker::ChileRut.rut(min_rut: 20_890_156) #=> 31853211
 
 # Every call to rut or full_rut generates a new random rut, so last_rut and dv

doc/default/code.md

@@ -11,6 +11,7 @@ Faker::Code.rut #=> "91389184-8"
 
 Faker::Code.nric #=> "S5589083H"
 
+# Keyword arguments: min_age, max_age
 Faker::Code.nric(min_age: 27, max_age: 34) #=> S8505970Z
 
 Faker::Code.imei #= "546327785982623"

doc/default/commerce.md

@@ -3,7 +3,7 @@
 ```ruby
 Faker::Commerce.color #=> "lavender"
 
-# Keyword arguments max: 3, fixed_amount: false
+# Keyword arguments: max, fixed_amount
 Faker::Commerce.department #=> "Grocery, Health & Beauty"
 Faker::Commerce.department(max: 5) #=> "Grocery, Books, Health & Beauty"
 Faker::Commerce.department(max: 2, fixed_amount: true) #=> "Books & Tools"
@@ -13,11 +13,12 @@ Faker::Commerce.material #=> "Steel"
 Faker::Commerce.product_name #=> "Practical Granite Shirt"
 
 # Produces a Float by default
+# Keyword arguments: range, as_string
 Faker::Commerce.price #=> 44.6
 Faker::Commerce.price(range: 0..10.0, as_string: true) #=> "2.18"
 
 # Generate a random promotion code.
-# Keyword argument digits: 6 for number of random digits in suffix
+# Keyword arguments: digits
 Faker::Commerce.promotion_code #=> "AmazingDeal829102"
 Faker::Commerce.promotion_code(digits: 2) #=> "AmazingPrice57"
 

doc/default/company.md

@@ -70,6 +70,7 @@ Faker::Company.south_african_trust_registration_number #=> "IT38/6489900"
 Faker::Company.brazilian_company_number #=> "18553414000618"
 
 # Get a random formatted Brazilian company number (CNPJ)
+# Keyword arguments: formatted
 Faker::Company.brazilian_company_number(formatted: true) #=> "00.000.000/0000-00"
 
 # Get a random USA Standard Industrial Classification code (SIC)

doc/default/date.md

@@ -2,17 +2,22 @@
 
 ```ruby
 # Random date between dates
+# Keyword arguments: from, to
 Faker::Date.between(from: 2.days.ago, to: Date.today) #=> "Wed, 24 Sep 2014"
 
 # Random date between dates except for certain date
+# Keyword arguments: from, to, excepted
 Faker::Date.between_except(from: 1.year.ago, to: 1.year.from_now, excepted: Date.today) #=> "Wed, 24 Sep 2014"
 
 # Random date in the future (up to maximum of N days)
+# Keyword arguments: days
 Faker::Date.forward(days: 23) # => "Fri, 03 Oct 2014"
 
 # Random date in the past (up to maximum of N days)
+# Keyword arguments: days
 Faker::Date.backward(days: 14) #=> "Fri, 19 Sep 2014"
 
 # Random birthday date (maximum age between 18 and 65)
+# Keyword arguments: min_age, max_age
 Faker::Date.birthday(min_age: 18, max_age: 65) #=> "Mar, 28 Mar 1986"
 ```

doc/default/demographic.md

@@ -15,5 +15,6 @@ Faker::Demographic.sex #=> "Female"
 
 Faker::Demographic.height #=> "1.61"
 
+# Keyword arguments: unit
 Faker::Demographic.height(unit: :imperial) #=> "6 ft, 2 in"
 ```

doc/default/fillmurray.md

@@ -3,9 +3,8 @@
 Available since version 1.7.1.
 
 ```ruby
+# Keyword arguments: grayscale, width, height
 Faker::Fillmurray.image #=> "http://www.fillmurray.com/300/300"
-
 Faker::Fillmurray.image(grayscale: true) #=> "http://fillmurray.com/g/300/300"
-
 Faker::Fillmurray.image(grayscale: false, width: 200, height: 400) #=> "http://fillmurray.com/200/400"
 ```

doc/default/finance.md

@@ -7,6 +7,7 @@ Faker::Finance.credit_card(:mastercard) #=> "6771-8921-2291-6236"
 Faker::Finance.credit_card(:mastercard, :visa) #=> "4448-8934-1277-7195"
 
 # Random vat number
+# Keyword arguments: country
 Faker::Finance.vat_number #=> "BR38.395.329/2471-83"
 Faker::Finance.vat_number(country: 'DE') #=> "DE593306671"
 Faker::Finance.vat_number(country: 'ZA') #=> "ZA79494416181"

doc/default/hipster.md

@@ -5,37 +5,37 @@ Adapted from [Hipster Ipsum](http://hipsum.co/)
 ```ruby
 Faker::Hipster.word #=> "irony"
 
-# Keyword arguments: number: 3, supplemental: false, spaces_allowed: false
+# Keyword arguments: number, supplemental, spaces_allowed
 Faker::Hipster.words #=> ["pug", "pitchfork", "chia"]
 Faker::Hipster.words(number: 4) #=> ["ugh", "cardigan", "poutine", "stumptown"]
 Faker::Hipster.words(number: 4, supplemental: true) #=> ["iste", "seitan", "normcore", "provident"]
 Faker::Hipster.words(number: 4, supplemental: true, spaces_allowed: true) #=> ["qui", "magni", "craft beer", "est"]
 
-# Keyword arguments: word_count: 4, supplemental: false, random_words_to_add: 6
+# Keyword arguments: word_count, supplemental, random_words_to_add
 Faker::Hipster.sentence #=> "Park iphone leggings put a bird on it."
 Faker::Hipster.sentence(word_count: 3) #=> "Pour-over swag godard."
 Faker::Hipster.sentence(word_count: 3, supplemental: true) #=> "Beard laboriosam sequi celiac."
 Faker::Hipster.sentence(word_count: 3, supplemental: false, random_words_to_add: 4) #=> "Bitters retro mustache aesthetic biodiesel 8-bit."
 Faker::Hipster.sentence(word_count: 3, supplemental: true, random_words_to_add: 4) #=> "Occaecati deleniti messenger bag meh crucifix autem."
 
-# Keyword arguments: number: 3, supplemental: false
+# Keyword arguments: number, supplemental
 Faker::Hipster.sentences #=> ["Godard pitchfork vinegar chillwave everyday 90's whatever.", "Pour-over artisan distillery street waistcoat.", "Salvia yr leggings franzen blue bottle."]
 Faker::Hipster.sentences(number: 1) #=> ["Before they sold out pinterest venmo umami try-hard ugh hoodie artisan."]
 Faker::Hipster.sentences(number: 1, supplemental: true) #=> ["Et sustainable optio aesthetic et."]
 
-# Keyword arguments: sentence_count: 3, supplemental: false, random_sentences_to_add: 3
+# Keyword arguments: sentence_count, supplemental, random_sentences_to_add
 Faker::Hipster.paragraph #=> "Migas fingerstache pbr&b tofu. Polaroid distillery typewriter echo tofu actually. Slow-carb fanny pack pickled direct trade scenester mlkshk plaid. Banjo venmo chambray cold-pressed typewriter. Fap skateboard intelligentsia."
 Faker::Hipster.paragraph(sentence_count: 2) #=> "Yolo tilde farm-to-table hashtag. Lomo kitsch disrupt forage +1."
 Faker::Hipster.paragraph(sentence_count: 2, supplemental: true) #=> "Typewriter iste ut viral kombucha voluptatem. Sint voluptates saepe. Direct trade irony chia excepturi yuccie. Biodiesel esse listicle et quam suscipit."
 Faker::Hipster.paragraph(sentence_count: 2, supplemental: false, random_sentences_to_add: 4) #=> "Selvage vhs chartreuse narwhal vinegar. Authentic vinyl truffaut carry vhs pop-up. Hammock everyday iphone locavore thundercats bitters vegan goth. Fashion axe banh mi shoreditch whatever artisan."
 Faker::Hipster.paragraph(sentence_count: 2, supplemental: true, random_sentences_to_add: 4) #=> "Deep v gluten-free unde waistcoat aperiam migas voluptas dolorum. Aut drinking illo sustainable sapiente. Direct trade fanny pack kale chips ennui semiotics."
 
-# Keyword arguments: number: 3, supplemental: false
+# Keyword arguments: number, supplemental
 Faker::Hipster.paragraphs #=> ["Tilde microdosing blog cliche meggings. Intelligentsia five dollar toast forage yuccie. Master kitsch knausgaard. Try-hard everyday trust fund mumblecore.", "Normcore viral pickled. Listicle humblebrag swag tote bag. Taxidermy street hammock neutra butcher cred kale chips. Blog portland humblebrag trust fund irony.", "Single-origin coffee fixie cleanse tofu xoxo. Post-ironic tote bag ramps gluten-free locavore mumblecore hammock. Umami loko twee. Ugh kitsch before they sold out."]
 Faker::Hipster.paragraphs(number: 1) #=> ["Skateboard cronut synth +1 fashion axe. Pop-up polaroid skateboard asymmetrical. Ennui fingerstache shoreditch before they sold out. Tattooed pitchfork ramps. Photo booth yr messenger bag raw denim bespoke locavore lomo synth."]
 Faker::Hipster.paragraphs(number: 1, supplemental: true) #=> ["Quae direct trade pbr&b quo taxidermy autem loko. Umami quas ratione migas cardigan sriracha minima. Tenetur perspiciatis pickled sed eum doloribus truffaut. Excepturi dreamcatcher meditation."]
 
-# Keyword arguments: characters: 3, supplemental: false
+# Keyword arguments: characters, supplemental
 Faker::Hipster.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."
 Faker::Hipster.paragraph_by_chars(characters: 256, supplemental: false) #=> "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."
 ```

doc/default/id_number.md

@@ -25,5 +25,6 @@ Faker::IDNumber.invalid_south_african_id_number #=> "1642972065088"
 Faker::IDNumber.brazilian_citizen_number #=> "53540542221"
 
 # Generate a formatted Brazilian CPF
+# Keyword arguments: formatted
 Faker::IDNumber.brazilian_citizen_number(formatted: true) #=> 000.000.000-00
 ```

doc/default/internet.md

@@ -1,45 +1,35 @@
 # Faker::Internet
 
 ```ruby
-# Keyword arguments name: nil, separators: nil
+# Keyword arguments: name, separators
 Faker::Internet.email #=> "[email protected]"
-
 Faker::Internet.email(name: 'Nancy') #=> "[email protected]"
-
 Faker::Internet.email(name: 'Janelle Santiago', separators: '+') #=> [email protected]"
 
-# Keyword argument name: nil
+# Keyword arguments: name
 Faker::Internet.free_email #=> "[email protected]"
-
 Faker::Internet.free_email(name: 'Nancy') #=> "[email protected]"
 
-# Keyword argument name: nil
+# Keyword arguments: name
 Faker::Internet.safe_email #=> "[email protected]"
-
 Faker::Internet.safe_email(name: 'Nancy') #=> "[email protected]"
 
-# Keyword arguments specifier: nil, separators: %w(. _)
+# Keyword arguments: specifier, separators
 Faker::Internet.username #=> "alexie"
-
 Faker::Internet.username(specifier: 'Nancy') #=> "nancy"
-
 Faker::Internet.username(specifier: 'Nancy Johnson', separators: %w(. _ -)) #=> "johnson-nancy"
 
-# Keyword arguments: min_length: 5, max_length: 8
+# Keyword arguments: min_length, max_length
 Faker::Internet.username(specifier: 5..8)
 
-# Keyword argument min_length: 8
+# Keyword arguments: min_length
 Faker::Internet.username(specifier: 8)
 
-# Keyword arguments: min_length: 8, max_length: 16
+# Keyword arguments: min_length, max_length, mix_case, special_chars
 Faker::Internet.password #=> "Vg5mSvY1UeRg7"
-
 Faker::Internet.password(min_length: 8) #=> "YfGjIk0hGzDqS0"
-
 Faker::Internet.password(min_length: 10, max_length: 20) #=> "EoC9ShWd1hWq4vBgFw"
-
 Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true) #=> "3k5qS15aNmG"
-
 Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true, special_chars: true) #=> "*%NkOnJsH4"
 
 Faker::Internet.domain_name #=> "effertz.info"
@@ -62,21 +52,21 @@ Faker::Internet.ip_v6_address #=> "ac5f:d696:3807:1d72:2eb5:4e81:7d2b:e1df"
 
 Faker::Internet.ip_v6_cidr #=> "ac5f:d696:3807:1d72:2eb5:4e81:7d2b:e1df/78"
 
-# Keyword argument prefix: ''
+# Keyword arguments: prefix
 Faker::Internet.mac_address #=> "e6:0d:00:11:ed:4f"
 Faker::Internet.mac_address(prefix: '55:44:33') #=> "55:44:33:02:1d:9b"
 
-# Keyword arguments: host: domain_name, path: "/#{username}", scheme: scheme
+# Keyword arguments: host, path, scheme
 Faker::Internet.url #=> "http://thiel.com/chauncey_simonis"
 Faker::Internet.url(host: 'example.com') #=> "http://example.com/clotilde.swift"
 Faker::Internet.url(host: 'example.com', path: '/foobar.html') #=> "http://example.com/foobar.html"
 
-# Keyword arguments: words: nil, glue: nil
+# Keyword arguments: words, glue
 Faker::Internet.slug #=> "pariatur_laudantium"
 Faker::Internet.slug(words: 'foo bar') #=> "foo.bar"
 Faker::Internet.slug(words: 'foo bar', glue: '-') #=> "foo-bar"
 
-# Keyword argument: vendor: nil
+# Keyword arguments: vendor
 Faker::Internet.user_agent #=> "Mozilla/5.0 (compatible; MSIE 9.0; AOL 9.7; AOLBuild 4343.19; Windows NT 6.1; WOW64; Trident/5.0; FunWebProducts)"
 Faker::Internet.user_agent(vendor: :firefox) #=> "Mozilla/5.0 (Windows NT x.y; Win64; x64; rv:10.0) Gecko/20100101 Firefox/10.0"