Skip to content

Commit

Permalink
Fixing documentation - Faker::Name to Faker::Zelda (#1256)
Browse files Browse the repository at this point in the history
* Added missing method to name documentation.

* Removed duplicate capital_city documentation.

* Fixed title and added code_word method to Faker::NatoPhoneticAlphabet documentation.

* Added missing methods to the Faker::Number documentation.

* Added call_squadron and call_number to Faker::StarWars documentation.

* Added explicit sport method in Faker::Team. Previously it was just passing through to method_missing.

* Added prefix, suffix and greek_alphabet to Faker::University documentation.
  • Loading branch information
mrstebo authored and vbrazo committed May 26, 2018
1 parent 4d50cfe commit 05b7474
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 3 deletions.
2 changes: 2 additions & 0 deletions doc/name.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,6 @@ Faker::Name.title #=> "Legacy Creative Director"

Faker::Name.initials #=> "NJM"
Faker::Name.initials(2) #=> "NM"

Faker::Name.job_titles #=> [""Supervisor", "Associate", ...]
```
1 change: 0 additions & 1 deletion doc/nation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@ Faker::Nation.language #=> "Nepali"

# Random Capital City
Faker::Nation.capital_city #=> "Kathmandu"
Faker::Nation.capital_city #=> "New Delhi"
4 changes: 2 additions & 2 deletions doc/nato_phonetic_alphabet.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Faker::Hobbit
# Faker::NatoPhoneticAlphabet

```ruby
# A code word from the NATO phonetic alphabet
Faker::NatoPhoneticAlphabet #=> "Hotel"
Faker::NatoPhoneticAlphabet.code_word #=> "Hotel"
```
8 changes: 8 additions & 0 deletions doc/number.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
# Required parameter: digits
Faker::Number.number(10) #=> "1968353479"

# Required parameter: digits
Faker::Number.leading_zero_number(10) #=> "0669336915"

# Required parameter: digits
Faker::Number.decimal_part(2) #=> "0074009009"

# Required parameter: l_digits
Faker::Number.decimal(2) #=> "11.88"

Expand All @@ -23,5 +29,7 @@ Faker::Number.positive #=> 235.59238499107653

Faker::Number.negative #=> -4480.042585669558

Faker::Number.non_zero_digit #=> "8"

Faker::Number.digit #=> "1"
```
4 changes: 4 additions & 0 deletions doc/star_wars.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@
Available since version 1.6.2.

```ruby
Faker::StarWars.call_squadron #=> "Green"

Faker::StarWars.call_sign #=> "Grey 5"

Faker::StarWars.call_number #=> "Leader"

Faker::StarWars.character #=> "Anakin Skywalker"

Faker::StarWars.droid #=> "C-3PO"
Expand Down
10 changes: 10 additions & 0 deletions doc/university.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ Available since version 1.5.0.
```ruby
# Random University Name
Faker::University.name #=> "South Texas College"

# Random University Prefix
Faker::University.prefix #=> "North"

# Random University Suffix
Faker::University.suffix #=> "Institute"

# Random Greek Organization
Faker::University.greek_organization #=> "ABΓ"

# Greek Alphabet
Faker::University.greek_alphabet #=> ["Α", "B", "Γ", "Δ", ...]
```
4 changes: 4 additions & 0 deletions lib/faker/team.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ def state
fetch('address.state')
end

def sport
fetch('team.sport')
end

def mascot
fetch('team.mascot')
end
Expand Down

0 comments on commit 05b7474

Please sign in to comment.