From d8e48fa0f49321780e930a6f17889fa2282949dc Mon Sep 17 00:00:00 2001
From: Lucas Sapienza <sapienzalucas@gmail.com>
Date: Thu, 14 Nov 2019 12:57:56 -0300
Subject: [PATCH] add YARD doc for Faker::Coin  (#1803)

* add coin docs

* Update lib/faker/default/coin.rb

Co-Authored-By: Connor Shea <connor.james.shea@gmail.com>

* Update lib/faker/default/coin.rb

Co-Authored-By: Connor Shea <connor.james.shea@gmail.com>
---
 lib/faker/default/coin.rb | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/lib/faker/default/coin.rb b/lib/faker/default/coin.rb
index 0b606b15ec..91d2e22cc9 100644
--- a/lib/faker/default/coin.rb
+++ b/lib/faker/default/coin.rb
@@ -3,10 +3,28 @@
 module Faker
   class Coin < Base
     class << self
+      ##
+      # Retrieves a random coin from any country.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coin.name #=> "Brazilian Real"
+      #
+      # @faker.version 1.9.2
       def name
         fetch('currency.name')
       end
 
+      ##
+      # Retrieves a face to a flipped coin
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coin.flip #=> "Heads"
+      #
+      # @faker.version 1.9.2
       def flip
         fetch('coin.flip')
       end