Skip to content

Commit

Permalink
Add YARD docs for Faker:Verb
Browse files Browse the repository at this point in the history
  • Loading branch information
michebble committed Jan 22, 2020
1 parent b9e1e29 commit 0ad058a
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 verb.
#
# @return [String]
#
# @example
# Faker::Verbs.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
Expand Down

0 comments on commit 0ad058a

Please sign in to comment.