review the total_cmp documentation #93403
Conversation
|
r? @dtolnay (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
nagisa
force-pushed
the
total-cmp-review
branch
from
5fb00aa
to
ed9e842
Compare
library/core/src/num/f32.rs
Outdated
| /// the `totalOrder` predicate as defined in the IEEE 754 (2008 revision) | ||
| /// floating point standard. The values are ordered in the following sequence: | ||
| /// | ||
| /// - Negative quiet NaN; |
There was a problem hiding this comment.
I don't think the punctuation at the end of every list item here makes it easier to read. The bulleted list doesn't need to be treated as though it's part of a sentence.
There was a problem hiding this comment.
Huh, I was under an impression that semicolon-separated list items were the blessed way of the bulleted lists.
Turns out that's not the case. Just like with anything else pertaining to English punctuation, everybody seems to come up with their own rules…
|
Some minor nits; looks good to me otherwise. Feel free to r=me with those fixed. |
nagisa
force-pushed
the
total-cmp-review
branch
from
ed9e842
to
72415f4
Compare
This comment has been minimized.
This comment has been minimized.
|
The CI failure does not look related. |
|
@nagisa Yeah, everything is failing on that in CI right now, pretty much. |
|
Posted one extremely minor nit, which I don't feel strongly about. With or without that change, r=me when CI is functioning. |
The documentation has been restructured to split out a brief summary paragraph out from the following elaborating paragraphs. I also attempted my hand at wording improvements and adding articles where I felt them missing, but being non-native english speaker these may need more thorough review.
nagisa
force-pushed
the
total-cmp-review
branch
from
72415f4
to
78efb07
Compare
|
@bors r=joshtriplett |
|
📌 Commit 78efb07 has been approved by |
bors
added
S-waiting-on-bors
…lett review the total_cmp documentation The documentation has been restructured to split out a brief summary paragraph out from the following elaborating paragraphs. I also attempted my hand at wording improvements and adding articles where I felt them missing, but being non-native english speaker these may need more thorough review. cc rust-lang#72599
…askrgr Rollup of 8 pull requests Successful merges: - rust-lang#93395 (Improve suggestion for escaping reserved keywords) - rust-lang#93403 (review the total_cmp documentation) - rust-lang#93461 (Accommodate yield points in the format_args expansion) - rust-lang#93462 (Document `SystemTime` platform precision) - rust-lang#93471 (unix: Use metadata for `DirEntry::file_type` fallback) - rust-lang#93480 (Remove deprecated and unstable slice_partition_at_index functions) - rust-lang#93485 (core: Remove some redundant {}s from the sorting code) - rust-lang#93494 (kmc-solid: Inherit the calling task's base priority in `Thread::new`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
|
Thank you! |
The documentation has been restructured to split out a brief summary
paragraph out from the following elaborating paragraphs.
I also attempted my hand at wording improvements and adding articles
where I felt them missing, but being non-native english speaker these
may need more thorough review.
cc #72599