-
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
update documentation to include Float type #2204
Merged
koic
merged 2 commits into
faker-ruby:master
from
BigBigDoudou:update_documentation_for_between_and_within
Feb 23, 2021
Merged
update documentation to include Float type #2204
koic
merged 2 commits into
faker-ruby:master
from
BigBigDoudou:update_documentation_for_between_and_within
Feb 23, 2021
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue#
No-Story
Description:
Update documentation for
Number#between
andNumber#within
to be more accurate. Indeed, these methods acceptInteger
andFloat
and returns anInteger
or aFloat
, 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 (replacingInteger, Float
byNumeric
to keep consistency in the documentation).