Update docs about round() function. #230
Merged
Conversation
This file contains hidden or 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
Lojjs
added
bug
Collaborator
|
Looks like you've updated the documentation! Check out your changes at https://neo4j-docs-cypher-230.surge.sh |
Contributor
Author
Contributor
Author
nadja-muller
requested changes
Nov 29, 2022
Contributor
nadja-muller
left a comment
nadja-muller
left a comment
There was a problem hiding this comment.
I think this is a great improvement! I left some remarks where I think we could do even better 😁
Collaborator
JPryce-Aklundh
left a comment
JPryce-Aklundh
left a comment
There was a problem hiding this comment.
Looks good! I just have one question and one suggestion.
| == round(), with precision | ||
|
|
||
| `round()` returns the value of the given number rounded with the specified precision, with half-values always being rounded up. | ||
| `round()` returns the value of the given number rounded to the closest value of given precision, with ties always being rounded away from zero (rounding mode `HALF_UP`). |
Collaborator
There was a problem hiding this comment.
Could this instead read: (using rounding mode HALF_UP)
or
(the default rounding mode is HALF_UP)
| *Considerations:* | ||
| |=== | ||
|
|
||
| | For the rounding modes, a tie refers to that the two closest values of the given precision are on the same distance from the given value. |
Collaborator
There was a problem hiding this comment.
Suggested change
| | For the rounding modes, a tie refers to that the two closest values of the given precision are on the same distance from the given value. | |
| | For the rounding modes, a tie means that the two closest values of the given precision are at the same distance from the given value. |
nadja-muller
approved these changes
Dec 6, 2022
JPryce-Aklundh
approved these changes
Dec 8, 2022
We follow the behaviour of Java, i.e. rounding towards positive infinity for ties when we have no precision or mode or rounding according to https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/math/RoundingMode.html for rounding modes. The current description was wrong in some cases and missleading in others. Also added more examples.
- Better description of round(x, precision) - Better description of HALF_UP and HALF_DOWN - Semantic order instead of alphabetical
This was referenced Dec 8, 2022
JPryce-Aklundh
added a commit
that referenced
this pull request
Dec 8, 2022
JPryce-Aklundh
added a commit
that referenced
this pull request
Dec 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
We follow the behaviour of Java, i.e. rounding towards positive infinity for ties when we have no precision or mode or rounding according to https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/math/RoundingMode.html for rounding modes.
The current description was wrong in some cases and missleading in others. Also added more examples.
Fixes #neo4j/neo4j#12972 and neo4j/neo4j#12963