doc/core: fix description of nth function
#27612
Conversation
The "nth" element can be confusing. In an array context, we know indexes start from 0 but one may believe this is not the case with "nth". For example, would `.nth(1)` return the first (1th/1st) or the second element? Rephrase a bit to be less confusing.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (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. 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. |
|
BTW, dunno if the source of the bot is available somewhere, but its language is confusing as well:
I think something is missing. |
| @@ -148,7 +148,7 @@ pub trait Iterator { | |||
| last | |||
| } | |||
|
|
|||
| /// Loops through `n` iterations, returning the `n`th element of the | |||
| /// Loops through `n` iterations, returning the next (`n+1`th) element of the | |||
There was a problem hiding this comment.
We shouldn't use a formulation with “n + 1 th”: the meaning of “nth” as used in this sentence is using a different indexing convention than the nth in the method name. Best to word it differently.
There was a problem hiding this comment.
What about:
Loops through
niterations, returning the next (nth) element of the iterator. The first element returned by the iterator is the "zeroth" one.
Or otherwise, just say it completely differently:
Returns the element at index
nby looping throughniterations and returning the next element of the iterator.
There was a problem hiding this comment.
I'd prefer the different version. Perhaps say skip and next element after that?
There was a problem hiding this comment.
So:
Returns the element at index
nby skipping thenfirst elements and returning the next one.
Or did you mean:
Skip the
nfirst elements of the iterator and return the next one.
There was a problem hiding this comment.
Commit updated with the new version.
https://github.com/nrc/highfive (it is a confusing sentence) |
vincentbernat
force-pushed
the
fix/doc/iter-nth
branch
from
407a478
to
721dc47
Compare
|
@steveklabnik this is already fixed: rust-lang/highfive@d4ddb75 |
|
@bors: r+ rollup |
|
📌 Commit 721dc47 has been approved by |
|
⌛ Testing commit 721dc47 with merge fd1e7d8... |
|
💔 Test failed - auto-linux-32-opt |
|
@bors retry |
…teveklabnik The "nth" element can be confusing. In an array context, we know indexes start from 0 but one may believe this is not the case with "nth". For example, would `.nth(1)` return the first (1th/1st) or the second element? Rephrase a bit to be less confusing. r? @steveklabnik
The "nth" element can be confusing. In an array context, we know indexes
start from 0 but one may believe this is not the case with "nth". For
example, would
.nth(1)return the first (1th/1st) or the secondelement? Rephrase a bit to be less confusing.
r? @steveklabnik