-
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 docs for Faker::Company #1915
Conversation
99bf7c5
to
d00515a
Compare
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.
For the comments, I think that it is best to follow the standard practise that has been used throughout this library.
So instead of Produces a company duns_number.
, it should be Produces a company duns number.
And maybe it would be worth adding an extra blank line between the @faker.version
and the useful developer comments, just to keep it clear that the two are not related to each other 😄
@mrstebo
|
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.
Thank you for making those changes. This is almost merge-ready. Just a few changes that need to be made for consistency 😉
lib/faker/default/company.rb
Outdated
# When a straight answer won't do, BS to the rescue! | ||
def bs | ||
translate('faker.company.bs').collect { |list| sample(list) }.join(' ') | ||
end | ||
|
||
## | ||
# Produces a company ein. |
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.
Should clarify what an EIN is.
# Produces a company ein. | |
# Produces a company EIN (Employer Identification Number). |
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.
@connorshea
Thank you for your suggestion.
I fixed it.
Co-Authored-By: Connor Shea <connor.james.shea@gmail.com>
…into add-yard-docs-for-company
@mrstebo |
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.
One last thing 😄
Co-Authored-By: Steven Atkinson <mrstebouk@gmail.com>
@mrstebo |
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.
Beautiful 😍
Issue#1762
Part of #1762.
Description:
Add yard docs for
Faker::Company
Avoid rubocop warning by replacing Spanish URL with % encoded URL