Skip to content

Commit

Permalink
Add YARD docs to Faker::Verb (#2008)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielTiringer committed May 22, 2020
1 parent 48fcc17 commit ebd2af7
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions lib/faker/default/verb.rb
Expand Up @@ -3,22 +3,67 @@
module Faker
class Verb < Base
class << self
##
# Produces the base form of a random verb.
#
# @return [String]
#
# @example
# Faker::Verb.base #=> "hurt"
#
# @faker.version 1.9.0
def base
fetch('verbs.base')
end

##
# Produces a random verb in past tense.
#
# @return [String]
#
# @example
# Faker::Verb.past #=> "completed"
#
# @faker.version 1.9.0
def past
fetch('verbs.past')
end

##
# Produces a random verb in past participle.
#
# @return [String]
#
# @example
# Faker::Verb.past_participle #=> "digested"
#
# @faker.version 1.9.0
def past_participle
fetch('verbs.past_participle')
end

##
# Produces a random verb in simple present.
#
# @return [String]
#
# @example
# Faker::Verb.simple_present #=> "climbs"
#
# @faker.version 1.9.0
def simple_present
fetch('verbs.simple_present')
end

##
# Produces a random verb in the .ing form.
#
# @return [String]
#
# @example
# Faker::Verb.ing_form #=> "causing"
#
# @faker.version 1.9.0
def ing_form
fetch('verbs.ing_form')
end
Expand Down

0 comments on commit ebd2af7

Please sign in to comment.