-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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 doc for Faker::Job #1797
Conversation
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.
Need to update the version numbers, but other than that LGTM
lib/faker/default/job.rb
Outdated
# @example | ||
# Faker::Job.title #=> "Construction Manager" | ||
# | ||
# @faker.version 1.9.2 |
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.
It looks like the versions here are off, the commit (bf0c351) was included in 1.7.0, so I think that's the correct version for title
, field
, and key_skill
.
position
was added in 1.8.7 it looks like?: 230a546
That one is kind of hard to pin down.
# @faker.version 1.9.2 | |
# @faker.version 1.7.0 |
lib/faker/default/job.rb
Outdated
# @example | ||
# Faker::Job.position #=> "Strategist" | ||
# | ||
# @faker.version 1.9.2 |
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.
# @faker.version 1.9.2 | |
# @faker.version 1.8.7 |
lib/faker/default/job.rb
Outdated
# @example | ||
# Faker::Job.field #=> "Banking" | ||
# | ||
# @faker.version 1.9.2 |
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.
# @faker.version 1.9.2 | |
# @faker.version 1.7.0 |
lib/faker/default/job.rb
Outdated
# @example | ||
# Faker::Job.key_skill #=> "Leadership" | ||
# | ||
# @faker.version 1.9.2 |
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.
# @faker.version 1.9.2 | |
# @faker.version 1.7.0 |
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.
Thanks 👍
* add YARD doc for Faker::Job * update faker versions
* add YARD doc for Faker::Job * update faker versions
Add complete YARD docs for Faker::Job methods.