Updated versions in doc for methods. (#2123)

faker-ruby · Sep 20, 2020 · 49ef136 · 49ef136
1 parent a7c823c
commit 49ef136
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 47 deletions.
diff --git a/lib/faker/default/barcode.rb b/lib/faker/default/barcode.rb
@@ -11,7 +11,7 @@ class << self
       #     Faker::Barcode.ean(8)   => "30152700"
       #     Faker::Barcode.ean(13)  => "2115190480285"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def ean(length = 8)
         generate_barcode("barcode.ean_#{Integer(length)}")
       end
@@ -24,7 +24,7 @@ def ean(length = 8)
       #     Faker::Barcode.ean_with_composite_sumbology(8)   => "38357961|XUYJ3266"
       #     Faker::Barcode.ean_with_composite_sumbology(13)  => "9530722443911|CKHWQHID"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def ean_with_composite_symbology(length = 8)
         "#{ean(length)}|#{bothify(parse('barcode.composite_symbol'))}"
       end
@@ -35,7 +35,7 @@ def ean_with_composite_symbology(length = 8)
       #  @example
       #     Faker::Barcode.upc_a      => "766807541831"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def upc_a
         generate_barcode('barcode.upc_a')
       end
@@ -46,7 +46,7 @@ def upc_a
       #  @example
       #     Faker::Barcode.upc_e      => "03746820"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def upc_e
         generate_barcode('barcode.upc_e')
       end
@@ -57,7 +57,7 @@ def upc_e
       #  @example
       #     Faker::Barcode.upc_a_with_composite_symbology      => "790670155765|JOVG6208"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def upc_a_with_composite_symbology
         "#{upc_a}|#{bothify(parse('barcode.composite_symbol'))}"
       end
@@ -68,7 +68,7 @@ def upc_a_with_composite_symbology
       #  @example
       #     Faker::Barcode.upc_e_with_composite_symbology      => "05149247|BKZX9722"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def upc_e_with_composite_symbology
         "#{upc_e}|#{bothify(parse('barcode.composite_symbol'))}"
       end
@@ -79,7 +79,7 @@ def upc_e_with_composite_symbology
       #  @example
       #     Faker::Barcode.isbn      => "9798363807732"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def isbn
         generate_barcode('barcode.isbn')
       end
@@ -90,7 +90,7 @@ def isbn
       #  @example
       #     Faker::Barcode.ismn      => "9790527672897"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def ismn
         generate_barcode('barcode.ismn')
       end
@@ -101,7 +101,7 @@ def ismn
       #  @example
       #     Faker::Barcode.issn      => "9775541703338"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def issn
         generate_barcode('barcode.issn')
       end
@@ -122,7 +122,7 @@ def generate_barcode(key)
       #   Faker::Barcode.send(:sum_even_odd, 12345)   => [9, 5]
       #   Faker::Barcode.send(:sum_even_odd, 87465)   => [17, 13]
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def sum_even_odd(fake_num)
         number = fake_num.to_i
         sum_even, sum_odd = 0, 0, index = 1
@@ -145,7 +145,7 @@ def sum_even_odd(fake_num)
       #   Faker::Barcode.send(:generate_check_digit, 12, 4)   => 0
       #   Faker::Barcode.send(:generate_check_digit, 23, 5)   => 6
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def generate_check_digit(odd_sum, even_sum)
         (10 - (odd_sum * 3 + even_sum) % 10) % 10
       end

diff --git a/lib/faker/default/driving_licence.rb b/lib/faker/default/driving_licence.rb
@@ -88,7 +88,7 @@ def uk_driving_licence(*args)
       #   Faker::DrivingLicence.usa_driving_licence('new mexico')   #=> "270692028"
       #   Faker::DrivingLicence.usa_driving_licence('New Mexico')   #=> "68178637"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def usa_driving_licence(state = 'California')
         bothify(fetch("driving_licence.usa.#{state.to_s.strip.downcase.gsub(' ', '_')}"))
       rescue I18n::MissingTranslationData => _e

diff --git a/lib/faker/default/drone.rb b/lib/faker/default/drone.rb
@@ -11,7 +11,7 @@ class << self
       # @example
       #   Faker::Drone.name #=> "DJI Mavic Air 2"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def name
         fetch('drone.name')
       end
@@ -24,7 +24,7 @@ def name
       # @example
       #   Faker::Drone.weight #=> "570 g"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def weight
         parse('drone.weight')
       end
@@ -37,7 +37,7 @@ def weight
       # @example
       #   Faker::Drone.max_ascent_speed #=> "4 m/s"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_ascent_speed
         parse('drone.max_ascent_speed')
       end
@@ -50,7 +50,7 @@ def max_ascent_speed
       # @example
       #   Faker::Drone.max_descent_speed #=> "4 m/s"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_descent_speed
         parse('drone.max_descent_speed')
       end
@@ -63,7 +63,7 @@ def max_descent_speed
       # @example
       #   Faker::Drone.flight_time #=> "34 min"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def flight_time
         parse('drone.flight_time')
       end
@@ -76,7 +76,7 @@ def flight_time
       # @example
       #   Faker::Drone.max_altitude #=> "5000 m"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_altitude
         parse('drone.max_altitude')
       end
@@ -89,7 +89,7 @@ def max_altitude
       # @example
       #   Faker::Drone.max_flight_distance #=> "18500 m"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_flight_distance
         parse('drone.max_flight_distance')
       end
@@ -102,7 +102,7 @@ def max_flight_distance
       # @example
       #   Faker::Drone.max_speed #=> "19 m/s"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_speed
         parse('drone.max_speed')
       end
@@ -115,7 +115,7 @@ def max_speed
       # @example
       #   Faker::Drone.max_wind_resistance #=> "10.5 m/s"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_wind_resistance
         parse('drone.max_wind_resistance')
       end
@@ -128,7 +128,7 @@ def max_wind_resistance
       # @example
       #   Faker::Drone.max_angular_velocity #=> "250 degree/s"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_angular_velocity
         parse('drone.max_angular_velocity')
       end
@@ -141,7 +141,7 @@ def max_angular_velocity
       # @example
       #   Faker::Drone.max_tilt_angle #=> "35 degrees"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_tilt_angle
         parse('drone.max_tilt_angle')
       end
@@ -154,7 +154,7 @@ def max_tilt_angle
       # @example
       #   Faker::Drone.operating_temperature #=> "14-104F"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def operating_temperature
         parse('drone.operating_temperature')
       end
@@ -167,7 +167,7 @@ def operating_temperature
       # @example
       #   Faker::Drone.battery_capacity #=> "3500 mAh"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def battery_capacity
         parse('drone.battery_capacity')
       end
@@ -180,7 +180,7 @@ def battery_capacity
       # @example
       #   Faker::Drone.battery_voltage #=> "13.2V"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def battery_voltage
         parse('drone.battery_voltage')
       end
@@ -193,7 +193,7 @@ def battery_voltage
       # @example
       #   Faker::Drone.battery_type #=> "LiPo 4S"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def battery_type
         parse('drone.battery_type')
       end
@@ -206,7 +206,7 @@ def battery_type
       # @example
       #   Faker::Drone.battery_weight #=> "198 g"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def battery_weight
         parse('drone.battery_weight')
       end
@@ -219,7 +219,7 @@ def battery_weight
       # @example
       #   Faker::Drone.charging_temperature #=> "41-104F"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def charging_temperature
         parse('drone.charging_temperature')
       end
@@ -232,7 +232,7 @@ def charging_temperature
       # @example
       #   Faker::Drone.max_charging_power #=> "38W"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_charging_power
         parse('drone.max_charging_power')
       end
@@ -245,7 +245,7 @@ def max_charging_power
       # @example
       #   Faker::Drone.iso #=> "100-3200"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def iso
         parse('drone.iso')
       end
@@ -258,7 +258,7 @@ def iso
       # @example
       #   Faker::Drone.max_resolution #=> "48MP"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_resolution
         parse('drone.max_resolution')
       end
@@ -271,7 +271,7 @@ def max_resolution
       # @example
       #   Faker::Drone.photo_format #=> "JPEG"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def photo_format
         parse('drone.photo_format')
       end
@@ -284,7 +284,7 @@ def photo_format
       # @example
       #   Faker::Drone.video_format #=> "MP4"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def video_format
         parse('drone.video_format')
       end
@@ -297,7 +297,7 @@ def video_format
       # @example
       #   Faker::Drone.shutter_speed_range #=> "8-1/8000s"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def shutter_speed_range
         "#{fetch('drone.max_shutter_speed')}-#{fetch('drone.min_shutter_speed')}#{fetch('drone.shutter_speed_units')}"
       end
@@ -310,7 +310,7 @@ def shutter_speed_range
       # @example
       #   Faker::Drone.max_shutter_speed #=> "60s"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def max_shutter_speed
         "#{fetch('drone.max_shutter_speed')}#{fetch('drone.shutter_speed_units')}"
       end
@@ -323,7 +323,7 @@ def max_shutter_speed
       # @example
       #   Faker::Drone.min_shutter_speed #=> "1/8000s"
       #
-      # @faker.version next
+      # @faker.version 2.14.0
       def min_shutter_speed
         "#{fetch('drone.min_shutter_speed')}#{fetch('drone.shutter_speed_units')}"
       end

diff --git a/lib/faker/games/dnd.rb b/lib/faker/games/dnd.rb
@@ -38,7 +38,7 @@ def background
         # @example
         #   Faker::Games::DnD.city #=> "Earthfast"
         #
-        # @faker.version next
+        # @faker.version 2.14.0
         def city
           fetch('dnd.cities')
         end
@@ -64,7 +64,7 @@ def klass
         # @example
         #   Faker::Games::DnD.language #=> "Gnomish"
         #
-        # @faker.version next
+        # @faker.version 2.14.0
         def language
           fetch('dnd.languages')
         end
@@ -77,7 +77,7 @@ def language
         # @example
         #   Faker::Games::DnD.melee_weapon #=> "Handaxe"
         #
-        # @faker.version next
+        # @faker.version 2.14.0
         def melee_weapon
           fetch('dnd.melee_weapons')
         end
@@ -90,7 +90,7 @@ def melee_weapon
         # @example
         #   Faker::Games::DnD.monster #=> "Manticore"
         #
-        # @faker.version next
+        # @faker.version 2.14.0
         def monster
           fetch('dnd.monsters')
         end
@@ -103,7 +103,7 @@ def monster
         # @example
         #   Faker::Games::DnD.races #=> "Dwarf"
         #
-        # @faker.version next
+        # @faker.version 2.14.0
         def race
           fetch('dnd.races')
         end
@@ -116,7 +116,7 @@ def race
         # @example
         #   Faker::Games::DnD.ranged_weapon #=> "Shortbow"
         #
-        # @faker.version next
+        # @faker.version 2.14.0
         def ranged_weapon
           fetch('dnd.ranged_weapons')
         end