Skip to content

improve Enumerate's docs, yields zero-based index #106531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

improve Enumerate's docs, yields zero-based index #106531

wants to merge 1 commit into from

Conversation

@liigo
Copy link
Contributor

@liigo liigo commented Jan 6, 2023

No description provided.

@rustbot
Copy link
Collaborator

rustbot commented Jan 6, 2023

r? @joshtriplett

(rustbot has picked a reviewer for you, use r? to override)
@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jan 6, 2023
@rustbot
Copy link
Collaborator

rustbot commented Jan 6, 2023

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs
JohnTitor
JohnTitor reviewed Jan 8, 2023
View reviewed changes
library/core/src/iter/adapters/enumerate.rs
use crate::ops::Try;

/// An iterator that yields the current count and the element during iteration.
/// An iterator that yields the zero-based index and the element during iteration.
Copy link
Member

@JohnTitor JohnTitor Jan 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this improves much, but this just rephrases the current one. Looking at the other docs, we don't usually mention the index is zero-based, see an Iterator itself or enumerate method's docs.
Also, the method docs' example shows that the count is zero-based and that's enough to explain, I think.
@anden3 anden3 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 5, 2023
@anden3
Copy link
Contributor

anden3 commented Apr 5, 2023

Hello @liigo! I'm pinging you as part of the triage procedure as you've received a review for this PR :)
@JohnCSimon
Copy link
Member

JohnCSimon commented May 28, 2023

@liigo

Ping from triage: I'm closing this due to inactivity as it hasn't been interaction from the author in a few months. Please reopen when you are ready to continue with this.
Note: if you are going to continue please open the PR BEFORE you push to it, else you won't be able to reopen - this is a quirk of github.
Thanks for your contribution.

@rustbot label: +S-inactive
@JohnCSimon JohnCSimon closed this May 28, 2023
@rustbot rustbot added the S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. label May 28, 2023
@liigo
Copy link
Contributor Author

liigo commented May 29, 2023

@JohnCSimon What are you expect me to interact? Since noone propose changing this PR, you (or other reviewers) are free to merge or refuse it. (I've read JohnTitor' review as refuse.)
@JohnCSimon
Copy link
Member

JohnCSimon commented Jul 30, 2023

@liigo I'm not a reviewer, triage is just to clean up deleted or abandoned PRs. - you can re-open the PR if you like.
@liigo liigo deleted the patch-13 branch November 13, 2025 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-libs Relevant to the library team, which will review and decide on the PR/issue.

6 participants

@liigo @rustbot @anden3 @JohnCSimon @JohnTitor @joshtriplett