Add YARD docs for Faker:Verb

lib/faker/default/educator.rb

@@ -5,6 +5,7 @@ class Educator < Base
     flexible :educator
 
     class << self
+<<<<<<< HEAD
       ##
       # Produces a university name.
       #
@@ -14,6 +15,8 @@ class << self
       #   Faker::Educator.university #=> "Mallowtown Technical College"
       #
       # @faker.version 1.6.4
+=======
+>>>>>>> Deprecate warnings should be removed in v2
       def university
         parse('educator.university')
       end

lib/faker/default/number.rb

@@ -3,6 +3,7 @@
 module Faker
   class Number < Base
     class << self
+<<<<<<< HEAD
       ##
       # Produce a random number.
       #
@@ -18,6 +19,11 @@ def number(legacy_digits = NOT_GIVEN, digits: 10)
           keywords << :digits if legacy_digits != NOT_GIVEN
         end
 
+=======
+      extend Gem::Deprecate
+
+      def number(digits = 10)
+>>>>>>> Deprecate Faker::Number.decimal_part and Faker::Number.leading_zero_number (#1516)
         return if digits < 1
         return rand(0..9).round if digits == 1
 
@@ -269,6 +275,9 @@ def should_be(number, method_to_compare)
           number * -1
         end
       end
+
+      deprecate :decimal_part, nil, 2019, 06
+      deprecate :leading_zero_number, nil, 2019, 06
     end
   end
 end

lib/faker/default/verb.rb

@@ -3,22 +3,67 @@
 module Faker
   class Verb < Base
     class << self
+      ##
+      # Produces the base form of a verb.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.base #=> "shape"
+      #
+      # @faker.version 1.9.0
       def base
         fetch('verbs.base')
       end
 
+      ##
+      # Produces the past form of a verb.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verbs.past #=> "motivated"
+      #
+      # @faker.version 1.9.0
       def past
         fetch('verbs.past')
       end
 
+      ##
+      # Produces the past participle form of a verb.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verbs.past_participle #=> "buzzed"
+      #
+      # @faker.version 1.9.0
       def past_participle
         fetch('verbs.past_participle')
       end
 
+      ##
+      # Produces the simple_present form of a verb.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verbs.simple_present #=> "gets"
+      #
+      # @faker.version 1.9.0
       def simple_present
         fetch('verbs.simple_present')
       end
 
+      ##
+      # Produces the -ing form of a verb.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verbs.ing_form #=> "climbing"
+      #
+      # @faker.version 1.9.0
       def ing_form
         fetch('verbs.ing_form')
       end