Fix documentation for Iterator::count().
#66094
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @cramertj (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
src/libcore/iter/traits/iterator.rs
Outdated
| @@ -202,8 +202,9 @@ pub trait Iterator { | |||
| /// Consumes the iterator, counting the number of iterations and returning it. | |||
| /// | |||
| /// This method will evaluate the iterator until its [`next`] returns | |||
| /// [`None`]. Once [`None`] is encountered, `count()` returns the number of | |||
| /// times it called [`next`]. | |||
| /// [`None`]. Once [`None`] is encountered, `count()` returns one less than the | |||
There was a problem hiding this comment.
This feels like a confusing way to state things. Perhaps something like this would be better: "count() will call [next()] until [None] is encountered, returning the number of times it saw Some(_)."
There was a problem hiding this comment.
Yeah that's a good point. Just replacing count() to "This method" at the beginning feels aesthetically more pleasing. Furthermore using a hyperlink reference to Some is probably beneficial. So may I suggest: "This method will call [next] repeatedly until [None] is encountered, returning the number of times it saw [Some]."
|
@bors r+ |
|
📌 Commit 23be25c has been approved by |
|
Ping from triage: |
|
As far as I understand this is ready to be merged, so pinging @cramertj in case he missed the previous ping. |
|
@bors r+ rollup |
|
📌 Commit 23be25c has been approved by |
bors
added
S-waiting-on-bors
Fix documentation for `Iterator::count()`. The documentation of std::core::Iterator::count() stated that the number returned is the number of times `next` is called on the iterator. However this is not true as the number of times `next` is called is exactly one plus the number returned by `count()`.
Rollup of 13 pull requests Successful merges: - #65932 (download .tar.xz if python3 is used) - #66074 ([mir-opt] Turn on the `ConstProp` pass by default) - #66094 (Fix documentation for `Iterator::count()`.) - #66166 (rename cfg(rustdoc) into cfg(doc)) - #66227 (docs: Fix link to BufWriter::flush) - #66292 (add Result::map_or) - #66297 (Add a callback that allows compiler consumers to override queries.) - #66317 (Use a relative bindir for rustdoc to find rustc) - #66330 (Improve non-exhaustiveness handling in usefulness checking) - #66331 (Add some tests for fixed ICEs) - #66334 (Move Session fields to CrateStore) - #66335 (Move self-profile infrastructure to data structures) - #66337 (Remove dead code for encoding/decoding lint IDs) Failed merges: r? @ghost
Fix documentation for `Iterator::count()`. The documentation of std::core::Iterator::count() stated that the number returned is the number of times `next` is called on the iterator. However this is not true as the number of times `next` is called is exactly one plus the number returned by `count()`.
Fix documentation for `Iterator::count()`. The documentation of std::core::Iterator::count() stated that the number returned is the number of times `next` is called on the iterator. However this is not true as the number of times `next` is called is exactly one plus the number returned by `count()`.
Rollup of 14 pull requests Successful merges: - #65932 (download .tar.xz if python3 is used) - #66094 (Fix documentation for `Iterator::count()`.) - #66166 (rename cfg(rustdoc) into cfg(doc)) - #66186 (Add long error explanation for E0623) - #66227 (docs: Fix link to BufWriter::flush) - #66248 (add raw ptr variant of UnsafeCell::get) - #66292 (add Result::map_or) - #66297 (Add a callback that allows compiler consumers to override queries.) - #66317 (Use a relative bindir for rustdoc to find rustc) - #66330 (Improve non-exhaustiveness handling in usefulness checking) - #66331 (Add some tests for fixed ICEs) - #66334 (Move Session fields to CrateStore) - #66335 (Move self-profile infrastructure to data structures) - #66337 (Remove dead code for encoding/decoding lint IDs) Failed merges: r? @ghost
The documentation of std::core::Iterator::count() stated that the number returned is the number of times
nextis called on the iterator. However this is not true as the number of timesnextis called is exactly one plus the number returned bycount().