Add more examples for clarifying full_address_as_hash usages

faker-ruby · May 19, 2020 · 24c8797 · 24c8797
1 parent c8b1602
commit 24c8797
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/lib/faker/default/address.rb b/lib/faker/default/address.rb
@@ -346,6 +346,15 @@ def full_address
       #                                       country_name_to_code: {name: 'united_states'})
       #     #=> {:longitude=>-101.74428917174603, :latitude=>-37.40056749089944, :country_name_to_code=>"US"}
       #
+      #  Faker::Address.full_address_as_hash(:full_address)
+      #     #=> {:full_address=>"87635 Rice Street, Lake Brentonton, OR 61896-5968"}
+      #
+      #  Faker::Address.full_address_as_hash(:city, :time_zone)
+      #     #=> {:city=>"East Faustina", :time_zone=>"America/Mexico_City"}
+      #
+      #  Faker::Address.full_address_as_hash(:street_address, street_address: {include_secondary: true})
+      #     #=> {:street_address=>"29423 Kenneth Causeway Suite 563"}
+      #
       # @faker.version next
       def full_address_as_hash(*attrs, **attrs_params)
         attrs.map!(&:to_sym)