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 Faker::BossaNova. #1849

Merged
merged 1 commit into from Dec 6, 2019
Merged
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
18 changes: 18 additions & 0 deletions lib/faker/default/bossa_nova.rb
Expand Up @@ -3,10 +3,28 @@
module Faker
class BossaNova < Base
class << self
##
# Produces the name of a bossa nova artist.
#
# @return [String]
#
# @example
# Faker::BossaNova.artist #=> "Tom Jobin"
#
# @faker.version 1.8.3
def artist
fetch('bossa_nova.artists')
end

##
# Produces a bossa nova song.
#
# @return [String]
#
# @example
# Faker::BossaNova.song #=> "Chega de Saudade"
#
# @faker.version 1.8.3
def song
fetch('bossa_nova.songs')
end
Expand Down