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

Update sport docs #2716

Merged
merged 3 commits into from
Feb 21, 2023
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions doc/sports/sport.md
Original file line number Diff line number Diff line change
@@ -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"
```
41 changes: 0 additions & 41 deletions doc/sports/sports.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

require_relative '../../test_helper'

class TestFakerSports < Test::Unit::TestCase
class TestFakerSport < Test::Unit::TestCase
def setup
@tester = Faker::Sport
end
Expand Down