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 doc for Faker::Job #1797

Merged
merged 2 commits into from
Dec 8, 2019
Merged

Conversation

ashishra0
Copy link
Contributor

Add complete YARD docs for Faker::Job methods.

Copy link
Member

@connorshea connorshea left a 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

# @example
# Faker::Job.title #=> "Construction Manager"
#
# @faker.version 1.9.2
Copy link
Member

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.

Suggested change
# @faker.version 1.9.2
# @faker.version 1.7.0

# @example
# Faker::Job.position #=> "Strategist"
#
# @faker.version 1.9.2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# @faker.version 1.9.2
# @faker.version 1.8.7

# @example
# Faker::Job.field #=> "Banking"
#
# @faker.version 1.9.2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# @faker.version 1.9.2
# @faker.version 1.7.0

# @example
# Faker::Job.key_skill #=> "Leadership"
#
# @faker.version 1.9.2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# @faker.version 1.9.2
# @faker.version 1.7.0

Copy link
Member

@vbrazo vbrazo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@vbrazo vbrazo merged commit b4a325f into faker-ruby:master Dec 8, 2019
michebble pushed a commit to michebble/faker that referenced this pull request Feb 16, 2020
* add YARD doc for Faker::Job

* update faker versions
davidmorton0 pushed a commit to davidmorton0/faker that referenced this pull request Jul 12, 2021
* add YARD doc for Faker::Job

* update faker versions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants