Improve documentation of rounding functions #16056
Closed
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
src/libcore/num/f32.rs
Outdated
There was a problem hiding this comment.
As long as you're updating these, it would be nice to change them to be more consistent with the prevailing style, i.e.
/// Rounds towards minus infinity.
(note: according to http://aturon.github.io/style/comments.html the summary line is supposed to end in punctuation, which I think is not actually how most of our comments work right now, but better to match the documented style).
|
Thanks for comments. I've changed other comments too, for consistency. |
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.
Important note: I documented current behaviour even though it may not be correct (see issue #15826).
round()function for rationals does different rounding thanround()fromFloattrait.