From 395cc3455b9cd488b9946bb8c75f46c0b16d93df Mon Sep 17 00:00:00 2001 From: Luan Date: Tue, 15 Oct 2019 11:45:10 -0300 Subject: [PATCH 1/2] Add yard docs for Faker::Coffee methods --- lib/faker/default/coffee.rb | 45 +++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/lib/faker/default/coffee.rb b/lib/faker/default/coffee.rb index 67588f248a..356b8ef498 100644 --- a/lib/faker/default/coffee.rb +++ b/lib/faker/default/coffee.rb @@ -5,24 +5,69 @@ class Coffee < Base flexible :coffee class << self + ## + # Produces a random blend name. + # + # @return [String] + # + # @example + # Faker::Coffee.blend_name #=> "Major Java" + # + # @faker.version next def blend_name parse('coffee.blend_name') end + ## + # Produces a random coffee origin place. + # + # @return [String] + # + # @example + # Faker::Coffee.origin #=> "Oaxaca, Mexico" + # + # @faker.version next def origin country = fetch('coffee.country') region = fetch("coffee.regions.#{search_format(country)}") "#{region}, #{country}" end + ## + # Produces a random coffee variety. + # + # @return [String] + # + # @example + # Faker::Coffee.variety #=> "Red Bourbon" + # + # @faker.version next def variety fetch('coffee.variety') end + ## + # Produces a string containing a random description of a coffee's taste. + # + # @return [String] + # + # @example + # Faker::Coffee.notes #=> "dull, tea-like, cantaloupe, soy sauce, marshmallow" + # + # @faker.version next def notes parse('coffee.notes') end + ## + # Produces a random coffee taste intensity. + # + # @return [String] + # + # @example + # Faker::Coffee.intensifier #=> "mild" + # + # @faker.version next def intensifier fetch('coffee.intensifier') end From 6646a133f0e0ced30a1218b1374f84ec7ac6c54f Mon Sep 17 00:00:00 2001 From: Vitor Oliveira Date: Mon, 11 Nov 2019 12:01:56 -0800 Subject: [PATCH 2/2] @faker.version should be 1.9.0 --- lib/faker/default/coffee.rb | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/faker/default/coffee.rb b/lib/faker/default/coffee.rb index 356b8ef498..42edc7936b 100644 --- a/lib/faker/default/coffee.rb +++ b/lib/faker/default/coffee.rb @@ -13,7 +13,7 @@ class << self # @example # Faker::Coffee.blend_name #=> "Major Java" # - # @faker.version next + # @faker.version 1.9.0 def blend_name parse('coffee.blend_name') end @@ -26,7 +26,7 @@ def blend_name # @example # Faker::Coffee.origin #=> "Oaxaca, Mexico" # - # @faker.version next + # @faker.version 1.9.0 def origin country = fetch('coffee.country') region = fetch("coffee.regions.#{search_format(country)}") @@ -41,7 +41,7 @@ def origin # @example # Faker::Coffee.variety #=> "Red Bourbon" # - # @faker.version next + # @faker.version 1.9.0 def variety fetch('coffee.variety') end @@ -54,7 +54,7 @@ def variety # @example # Faker::Coffee.notes #=> "dull, tea-like, cantaloupe, soy sauce, marshmallow" # - # @faker.version next + # @faker.version 1.9.0 def notes parse('coffee.notes') end @@ -67,7 +67,7 @@ def notes # @example # Faker::Coffee.intensifier #=> "mild" # - # @faker.version next + # @faker.version 1.9.0 def intensifier fetch('coffee.intensifier') end