From d4c1dbc4a8b668cd0d9edb8a0582a4f42adeddbd Mon Sep 17 00:00:00 2001 From: Connor Shea Date: Wed, 4 Dec 2019 19:45:19 -0700 Subject: [PATCH] Add YARD docs for Faker::BossaNova. --- lib/faker/default/bossa_nova.rb | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/lib/faker/default/bossa_nova.rb b/lib/faker/default/bossa_nova.rb index 0fca9d19b0..9a496f6f2d 100644 --- a/lib/faker/default/bossa_nova.rb +++ b/lib/faker/default/bossa_nova.rb @@ -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