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 Faker::Beer YARD docs #1790

Merged
merged 3 commits into from
Dec 8, 2019
Merged

Conversation

ashishra0
Copy link
Contributor

Add YARD docs for Faker::Beer

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.

Versions need to be updated, and some other minor feedback :)

# @example
# Faker::Beer.name #=> "Pliny The Elder"
#
# @faker.version next
Copy link
Member

Choose a reason for hiding this comment

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

These versions should be the actual version numbers :)

Based on 3d520c7, name, style, hop, yeast, malts, ibu, alcohol, and blg were all added in 1.6.2. brand was added in 1.9.2 (6c2298e).

def style
fetch('beer.style')
end

##
# Produces a random beer hops .
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
# Produces a random beer hops .
# Produces a random beer hops.

def yeast
fetch('beer.yeast')
end

##
# Produces a random beer malts.
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be singular?

Suggested change
# Produces a random beer malts.
# Produces a random beer malt.

def malts
fetch('beer.malt')
end

##
# Produces a random beer ibu.
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
# Produces a random beer ibu.
# Produces a random beer IBU.

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.

👍

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

* add version number

* Update beer.rb
davidmorton0 pushed a commit to davidmorton0/faker that referenced this pull request Jul 12, 2021
* add Faker::Beer YARD docs

* add version number

* Update beer.rb
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