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

Add YARD docs for the Basketball and Football fakers. #1761

Merged
merged 1 commit into from Sep 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 36 additions & 0 deletions lib/faker/sports/basketball.rb
Expand Up @@ -4,18 +4,54 @@ module Faker
class Sports
class Basketball < Base
class << self
##
# Produces the name of a basketball team.
#
# @return [String]
#
# @example
# Faker::Sports::Basketball.team #=> "Golden State Warriors"
#
# @faker.version 1.9.4
def team
fetch('basketball.teams')
end

##
# Produces the name of a basketball player.
#
# @return [String]
#
# @example
# Faker::Sports::Basketball.player #=> "LeBron James"
#
# @faker.version 1.9.4
def player
fetch('basketball.players')
end

##
# Produces the name of a basketball coach.
#
# @return [String]
#
# @example
# Faker::Sports::Basketball.coach #=> "Gregg Popovich"
#
# @faker.version 1.9.4
def coach
fetch('basketball.coaches')
end

##
# Produces a position in basketball.
#
# @return [String]
#
# @example
# Faker::Sports::Basketball.position #=> "Point Guard"
#
# @faker.version 1.9.4
def position
fetch('basketball.positions')
end
Expand Down
45 changes: 45 additions & 0 deletions lib/faker/sports/football.rb
Expand Up @@ -4,22 +4,67 @@ module Faker
class Sports
class Football < Base
class << self
##
# Produces the name of a football team.
#
# @return [String]
#
# @example
# Faker::Sports::Football.team #=> "Manchester United"
#
# @faker.version 1.9.0
def team
fetch('football.teams')
end

##
# Produces the name of a football player.
#
# @return [String]
#
# @example
# Faker::Sports::Football.player #=> "Lionel Messi"
#
# @faker.version 1.9.0
def player
fetch('football.players')
end

##
# Produces the name of a football coach.
#
# @return [String]
#
# @example
# Faker::Sports::Football.coach #=> "Jose Mourinho"
#
# @faker.version 1.9.0
def coach
fetch('football.coaches')
end

##
# Produces a football competition.
#
# @return [String]
#
# @example
# Faker::Sports::Football.competition #=> "FIFA World Cup"
#
# @faker.version 1.9.0
def competition
fetch('football.competitions')
end

##
# Produces a position in football.
#
# @return [String]
#
# @example
# Faker::Sports::Football.position #=> "Defensive Midfielder"
#
# @faker.version 1.9.2
def position
fetch('football.positions')
end
Expand Down