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 documentation to include Float type #2204

Merged
merged 2 commits into from
Feb 23, 2021
Merged

update documentation to include Float type #2204

merged 2 commits into from
Feb 23, 2021

Conversation

BigBigDoudou
Copy link
Contributor

@BigBigDoudou BigBigDoudou commented Nov 25, 2020

Issue#

No-Story

Description:

Update documentation for Number#between and Number#within to be more accurate. Indeed, these methods accept Integer and Float and returns an Integer or a Float, depending on the params type.

I've added examples in the documentation so it will be more obvious for next people who read it that they can use these methods to generate floats.

Examples in the yardoc documentation where Numeric is used as type (@return [Numeric]). It is not fully documented but as I understand, it covers these cases where a method accepts and/or returns Integer or Float.

I've changed the documentation for the #normal method (replacing Integer, Float by Numeric to keep consistency in the documentation).

@koic koic merged commit 0e219fa into faker-ruby:master Feb 23, 2021
@koic
Copy link
Member

koic commented Feb 23, 2021

Nice improvement!

This was referenced Mar 12, 2021
This was referenced Mar 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants