Skip to content

Improved slice documentation#127668

Merged
bors merged 1 commit into
rust-lang:masterfrom
spencer3035:improve-slice-doc
Jul 13, 2024
Merged

Improved slice documentation#127668
bors merged 1 commit into
rust-lang:masterfrom
spencer3035:improve-slice-doc

Conversation

@spencer3035

Copy link
Copy Markdown
Contributor

Improve slice documentation to include assert_eq checks for all the cases where there were existing examples. I think it makes things more clear when the documentation explicitly checks against values and shows the reader what it does.

I also started a rust internals discussion about it here: https://internals.rust-lang.org/t/improve-slice-documentaion/21168

@rustbot

rustbot commented Jul 12, 2024

Copy link
Copy Markdown
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @joboet (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@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 Jul 12, 2024
@jhpratt

jhpratt commented Jul 12, 2024

Copy link
Copy Markdown
Member

@bors r+ rollup

@bors

bors commented Jul 12, 2024

Copy link
Copy Markdown
Collaborator

📌 Commit c49a530 has been approved by jhpratt

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 12, 2024
@rust-log-analyzer

This comment has been minimized.

@jhpratt jhpratt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@bors r-

Failing CI. Let me know when it's fixed (please keep it as a single commit) and I'll re-approve.

@rustbot claim

Comment thread library/core/src/slice/iter.rs Outdated
@rustbot rustbot assigned jhpratt and unassigned joboet Jul 12, 2024
@spencer3035

Copy link
Copy Markdown
Contributor Author

Classic off by one error. Should be fixed now. @jhpratt

@jhpratt

jhpratt commented Jul 13, 2024

Copy link
Copy Markdown
Member

Can you squash it into one commit?

@spencer3035

Copy link
Copy Markdown
Contributor Author

I force pushed the two commits into one commit.

@jhpratt

jhpratt commented Jul 13, 2024

Copy link
Copy Markdown
Member

Thanks!

@bors r+

@bors

bors commented Jul 13, 2024

Copy link
Copy Markdown
Collaborator

📌 Commit 163d98b has been approved by jhpratt

It is now in the queue for this repository.

@bors bors merged commit f011913 into rust-lang:master Jul 13, 2024
@rustbot rustbot added this to the 1.81.0 milestone Jul 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants