Add YARD docs for Faker:Verb #1916
Conversation
| # @example | ||
| # Faker::Verbs.base #=> "shape" | ||
| # | ||
| # @faker.version 1.9.0 |
There was a problem hiding this comment.
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.
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.
Co-Authored-By: Connor Shea <connor.james.shea@gmail.com>
| # @return [String] | ||
| # | ||
| # @example | ||
| # Faker::Verbs.past #=> "motivated" |
There was a problem hiding this comment.
| # Faker::Verbs.past #=> "motivated" | |
| # Faker::Verb.past #=> "motivated" |
| # @return [String] | ||
| # | ||
| # @example | ||
| # Faker::Verbs.past_participle #=> "buzzed" |
There was a problem hiding this comment.
| # Faker::Verbs.past_participle #=> "buzzed" | |
| # Faker::Verb.past_participle #=> "buzzed" |
| # @return [String] | ||
| # | ||
| # @example | ||
| # Faker::Verbs.simple_present #=> "gets" |
There was a problem hiding this comment.
| # Faker::Verbs.simple_present #=> "gets" | |
| # Faker::Verb.simple_present #=> "gets" |
| # @return [String] | ||
| # | ||
| # @example | ||
| # Faker::Verbs.ing_form #=> "climbing" |
There was a problem hiding this comment.
| # Faker::Verbs.ing_form #=> "climbing" | |
| # Faker::Verb.ing_form #=> "climbing" |
|
Sorry I messed up a rebase and got into a weird state. I apologise, I am quite new to working on forked repos. I hope I didn't make too much of a mess. I'll be more careful in future. |
A small PR as part of the effort to add YARD docs #1762
I am using this to make sure I understand correctly how YARD docs should be added before adding them to more files.