diff --git a/doc/sports/sport.md b/doc/sports/sport.md new file mode 100644 index 0000000000..a9a1f325db --- /dev/null +++ b/doc/sports/sport.md @@ -0,0 +1,41 @@ +# Faker::Sport + +## Conventional (Olympic including Paralympic) Sports + +```ruby +# Any one of the below four categories: +Faker::Sport.sport #=> "Snowboard" + +Faker::Sport.summer_olympics_sport #=> "Triathlon" + +Faker::Sport.winter_olympics_sport #=> "Luge" + +Faker::Sport.summer_paralympics_sport #=> "Goalball" + +Faker::Sport.winter_paralympics_sport #=> "Wheelchair curling" +``` + +## Ancient Sports + +```ruby +Faker::Sport.ancient_olympics_sport #=> "Chariot racing" + +# Any modern or ancient olympic sport: +Faker::Sport.sport(include_ancient: true) #=> "Rugby" +``` + +## Unusual Sports (just for fun) + +```ruby +Faker::Sport.unusual_sport #=> "Camel wrestling" + +# Any modern olympic or unusual sport: +Faker::Sport.sport(include_unusual: true) #=> "Gurning" +``` + +## Full list + +```ruby +# Modern, ancient or unusual: +Faker::Sport.sport(include_ancient: true, include_unusual: true) #=> "Powerlifting" +``` diff --git a/doc/sports/sports.md b/doc/sports/sports.md deleted file mode 100644 index c2df2045fe..0000000000 --- a/doc/sports/sports.md +++ /dev/null @@ -1,41 +0,0 @@ -# Faker::Sports - -## Conventional (Olympic including Paralympic) Sports - -```ruby -# Any one of the below four categories: -Faker::Sports.sport #=> "Snowboard" - -Faker::Sports.summer_olympics_sport #=> "Triathlon" - -Faker::Sports.winter_olympics_sport #=> "Luge" - -Faker::Sports.summer_paralympics_sport #=> "Goalball" - -Faker::Sports.winter_paralympics_sport #=> "Wheelchair curling" -``` - -## Ancient Sports - -```ruby -Faker::Sports.ancient_olympics_sport #=> "Chariot racing" - -# Any modern or ancient olympic sport: -Faker::Sports.sport(include_ancient: true) #=> "Rugby" -``` - -## Unusual Sports (just for fun) - -```ruby -Faker::Sports.unusual_sport #=> "Camel wrestling" - -# Any modern olympic or unusual sport: -Faker::Sports.sport(include_unusual: true) #=> "Gurning" -``` - -## Full list - -```ruby -# Modern, ancient or unusual: -Faker::Sports.sport(include_ancient: true, include_unusual: true) #=> "Powerlifting" -``` diff --git a/test/faker/sports/test_faker_sports.rb b/test/faker/sports/test_faker_sport.rb similarity index 95% rename from test/faker/sports/test_faker_sports.rb rename to test/faker/sports/test_faker_sport.rb index b72f812dab..2871783258 100644 --- a/test/faker/sports/test_faker_sports.rb +++ b/test/faker/sports/test_faker_sport.rb @@ -2,7 +2,7 @@ require_relative '../../test_helper' -class TestFakerSports < Test::Unit::TestCase +class TestFakerSport < Test::Unit::TestCase def setup @tester = Faker::Sport end