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 docs for Faker::Company #1915

Merged
merged 11 commits into from
Feb 14, 2020

Conversation

kos31de
Copy link
Contributor

@kos31de kos31de commented Jan 21, 2020

Issue#1762

Part of #1762.

Description:

  • Add yard docs for Faker::Company

  • Avoid rubocop warning by replacing Spanish URL with % encoded URL

@kos31de kos31de requested a review from vbrazo January 21, 2020 02:04
@kos31de kos31de changed the title Add yard docs for company Add yard docs for Faker::Company Jan 21, 2020
Copy link
Contributor

@mrstebo mrstebo left a 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 😄

@kos31de
Copy link
Contributor Author

kos31de commented Feb 13, 2020

@mrstebo
Thank you for your comment.
I will fix two points below!

  • Following the standard practise in this library

  • Adding an extra blank line between the @faker.version and the useful developer comments

@kos31de kos31de requested a review from mrstebo February 13, 2020 03:48
Copy link
Contributor

@mrstebo mrstebo left a 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 😉

# 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.
Copy link
Member

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.

Suggested change
# Produces a company ein.
# Produces a company EIN (Employer Identification Number).

Copy link
Contributor Author

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.

@connorshea connorshea mentioned this pull request Feb 14, 2020
vbrazo and others added 4 commits February 14, 2020 00:17
@kos31de
Copy link
Contributor Author

kos31de commented Feb 14, 2020

@mrstebo
Thank you for your reply.
I'm sorry, I misunderstood.

Copy link
Contributor

@mrstebo mrstebo left a comment

Choose a reason for hiding this comment

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

One last thing 😄

lib/faker/default/company.rb Outdated Show resolved Hide resolved
Co-Authored-By: Steven Atkinson <mrstebouk@gmail.com>
@kos31de
Copy link
Contributor Author

kos31de commented Feb 14, 2020

@mrstebo
I fixed it😄

@kos31de kos31de requested a review from mrstebo February 14, 2020 13:55
Copy link
Contributor

@mrstebo mrstebo left a comment

Choose a reason for hiding this comment

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

Beautiful 😍

@vbrazo vbrazo merged commit 4ae95f4 into faker-ruby:master Feb 14, 2020
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.

4 participants