add some basic docs to test with

michebble · Feb 15, 2019 · a550584 · a550584
1 parent a854bd3
commit a550584
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/lib/faker/blockchain/bitcoin.rb b/lib/faker/blockchain/bitcoin.rb
@@ -12,10 +12,24 @@ class << self
           testnet: 111
         }.freeze
 
+        ##
+        # @return {String} A Bitcoin wallet address
+        #
+        # @example
+        #   "147nDP22h3pHrLt2qykTH4txUwQh1ccaXp"
+        #   "1PmjxnDM2oGusc8R776s8hNxdtAsNTnWrv"
+        #   "1CJ8rPhaTbTAP16kzdiHoayEPg6UFMjXhT"
         def address
           address_for(:main)
         end
 
+        ##
+        # @return {String} A Bitcoin testnet address
+        #
+        # @example
+        #   "n4YjRyYD6V6zREpk6opqESDqD3KYnMdVEB"
+        #   "miVEG5z3yoTe8p3Bjh9kh8MBQMb4QZ7d2w"
+        #   "n4PTm5skAEnieUve9wmDxtaLZ9UhCXVDzT"
         def testnet_address
           address_for(:testnet)
         end