Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing documentation - Faker::Name to Faker::Zelda #1256

Merged
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", ...]
Copy link
Member

@vbrazo vbrazo May 27, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should remove this method because now we have a Faker::Job API @mrstebo

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to open a PR and add a description explaining what's going on and fix it? We need to remove the locales, docs, tests and the method.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, no problem 👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When a method that has been in a gem release is being removed, we need to deprecate it before removing it so we don’t break people’s code. This would including printing a warning message in the release before it will be removed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mrstebo your PR would need to wait for 2 versions

```
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copy and 🍝 😆


```ruby
# A code word from the NATO phonetic alphabet
Faker::NatoPhoneticAlphabet #=> "Hotel"
Faker::NatoPhoneticAlphabet.code_word #=> "Hotel"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

```
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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

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