Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add YARD docs to Faker::Verb #2008

Merged
merged 1 commit into from May 22, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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