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

Update Faker::Number.between docs #1177

Merged
merged 2 commits into from
May 12, 2018
Merged

Update Faker::Number.between docs #1177

merged 2 commits into from
May 12, 2018

Conversation

Zeragamba
Copy link
Contributor

Just adding a simple note for future doc readers.

When I was looking up the documentation for Number.between I wasn't 100% sure if the boundary numbers were inclusive. Looking at the tests did show that it was.

doc/number.md Outdated
@@ -15,6 +15,7 @@ Faker::Number.normal(50, 3.5) #=> 47.14669604069156
# Required parameter: digits
Faker::Number.hexadecimal(3) #=> "e74"

# Boundry numbers are inclusive
Copy link
Member

Choose a reason for hiding this comment

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

Did you mean Boundary numbers? @SpyMaster356

- include required parameters
- fix typo
@Zeragamba
Copy link
Contributor Author

Whoops, thanks for catching that.

I've also added documentation for the required params too, as that was missing.

@vbrazo
Copy link
Member

vbrazo commented May 12, 2018

Good job. Thanks 👍🏻

@vbrazo vbrazo closed this May 12, 2018
@vbrazo vbrazo reopened this May 12, 2018
@vbrazo vbrazo merged commit 4ac9454 into faker-ruby:master May 12, 2018
@Zeragamba Zeragamba deleted the num-between-inclusive branch May 12, 2018 23:57
@vbrazo vbrazo changed the title Add note that Number.between is inclusive in docs Update Faker::Number.between docs May 16, 2018
@vbrazo vbrazo self-requested a review July 19, 2018 01:40
davidmorton0 pushed a commit to davidmorton0/faker that referenced this pull request Jul 12, 2021
* Add note that Number.between is inclusive

* update documentation for Faker::Number.between

- include required parameters
- fix typo
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.

2 participants