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 for Faker:Verb #1916
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -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" | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
# | ||||||
# @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" | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
# | ||||||
# @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" | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
# | ||||||
# @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" | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
# | ||||||
# @faker.version 1.9.0 | ||||||
def ing_form | ||||||
fetch('verbs.ing_form') | ||||||
end | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I couldn't find mention of
Faker::Verb
in the change logs, I tested this by comparing git blame to release history and then loading versions around that time to see when it became available.Is this a good way to determine the value for version, or is there a better way?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I usually just search for "Verb" in the GitHub repo and look for the earliest commit(s) mentioning it. You can see all the tags for the commit and the oldest one will be the first version it was included in.