From 10079a8e6acb6f85ca91524dbbab22f7f681ceb4 Mon Sep 17 00:00:00 2001 From: Mari <46435053+marientje@users.noreply.github.com> Date: Fri, 3 Apr 2020 09:26:12 +0900 Subject: [PATCH 1/3] add YARD docs to Faker::SlackEmoji --- lib/faker/default/slack_emoji.rb | 81 ++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/lib/faker/default/slack_emoji.rb b/lib/faker/default/slack_emoji.rb index d984f5e2c0..d33df889d3 100644 --- a/lib/faker/default/slack_emoji.rb +++ b/lib/faker/default/slack_emoji.rb @@ -3,38 +3,119 @@ module Faker class SlackEmoji < Base class << self + ## + # Produces a random slack emoji from people category + # + # @return [String] + # + # @example + # Faker::SlackEmoji.people #=> ":sleepy:" + # + # @faker.version 1.5.0 def people fetch('slack_emoji.people') end + ## + # Produces a random slack emoji from nature category + # + # @return [String] + # + # @example + # Faker::SlackEmoji.nature #=> ":mount_fuji:" + # + # @faker.version 1.5.0 def nature fetch('slack_emoji.nature') end + ## + # Produces a random slack emoji from food and drink category + # + # @return [String] + # + # @example + # Faker::SlackEmoji.food_and_drink #=> ":beers:" + # + # @faker.version 1.5.0 def food_and_drink fetch('slack_emoji.food_and_drink') end + ## + # Produces a random slack emoji from celebration category + # + # @return [String] + # + # @example + # Faker::SlackEmoji.celebration #=> ":tada:" + # + # @faker.version 1.5.0 def celebration fetch('slack_emoji.celebration') end + ## + # Produces a random slack emoji from activity category + # + # @return [String] + # + # @example + # Faker::SlackEmoji.activity #=> ":soccer:" + # + # @faker.version 1.5.0 def activity fetch('slack_emoji.activity') end + ## + # Produces a random slack emoji from travel and places category + # + # @return [String] + # + # @example + # Faker::SlackEmoji.travel_and_places #=> ":metro:" + # + # @faker.version 1.5.0 def travel_and_places fetch('slack_emoji.travel_and_places') end + ## + # Produces a random slack emoji from objects and symbols category + # + # @return [String] + # + # @example + # Faker::SlackEmoji.objects_and_symbols #=> ":id:" + # + # @faker.version 1.5.0 def objects_and_symbols fetch('slack_emoji.objects_and_symbols') end + ## + # Produces a random slack emoji from custom category + # + # @return [String] + # + # @example + # Faker::SlackEmoji.custom #=> ":slack:" + # + # @faker.version 1.5.0 def custom fetch('slack_emoji.custom') end + ## + # Produces a random slack emoji from any category + # + # @return [String] + # + # @example + # Faker::SlackEmoji.emoji #=> ":pizza:" + # + # @faker.version 1.5.0 def emoji parse('slack_emoji.emoji') end From b1a81d66191dea576bc2c5a7c0bdb15790cd2063 Mon Sep 17 00:00:00 2001 From: "Stephen A. Wilson" Date: Sat, 16 May 2020 20:06:50 -0400 Subject: [PATCH 2/3] Update lib/faker/default/slack_emoji.rb Co-authored-by: Koichi ITO --- lib/faker/default/slack_emoji.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/faker/default/slack_emoji.rb b/lib/faker/default/slack_emoji.rb index d33df889d3..8acd4ea4e9 100644 --- a/lib/faker/default/slack_emoji.rb +++ b/lib/faker/default/slack_emoji.rb @@ -4,7 +4,7 @@ module Faker class SlackEmoji < Base class << self ## - # Produces a random slack emoji from people category + # Produces a random slack emoji from people category. # # @return [String] # From e0fbba1dc947f29595eb4cbd99c31b8435778bf9 Mon Sep 17 00:00:00 2001 From: Mari <46435053+marientje@users.noreply.github.com> Date: Sun, 17 May 2020 11:23:44 +0900 Subject: [PATCH 3/3] Update lib/faker/default/slack_emoji.rb --- lib/faker/default/slack_emoji.rb | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/faker/default/slack_emoji.rb b/lib/faker/default/slack_emoji.rb index 8acd4ea4e9..b7a460be4a 100644 --- a/lib/faker/default/slack_emoji.rb +++ b/lib/faker/default/slack_emoji.rb @@ -17,7 +17,7 @@ def people end ## - # Produces a random slack emoji from nature category + # Produces a random slack emoji from nature category. # # @return [String] # @@ -30,7 +30,7 @@ def nature end ## - # Produces a random slack emoji from food and drink category + # Produces a random slack emoji from food and drink category. # # @return [String] # @@ -43,7 +43,7 @@ def food_and_drink end ## - # Produces a random slack emoji from celebration category + # Produces a random slack emoji from celebration category. # # @return [String] # @@ -56,7 +56,7 @@ def celebration end ## - # Produces a random slack emoji from activity category + # Produces a random slack emoji from activity category. # # @return [String] # @@ -69,7 +69,7 @@ def activity end ## - # Produces a random slack emoji from travel and places category + # Produces a random slack emoji from travel and places category. # # @return [String] # @@ -82,7 +82,7 @@ def travel_and_places end ## - # Produces a random slack emoji from objects and symbols category + # Produces a random slack emoji from objects and symbols category. # # @return [String] # @@ -95,7 +95,7 @@ def objects_and_symbols end ## - # Produces a random slack emoji from custom category + # Produces a random slack emoji from custom category. # # @return [String] # @@ -108,7 +108,7 @@ def custom end ## - # Produces a random slack emoji from any category + # Produces a random slack emoji from any category. # # @return [String] #