Home Original page

doc: describe panic conditions for SliceIndex implementations by JaniM · Pull Request #123271 · rust-lang/rust

@JaniM

@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

Mar 31, 2024

@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

Mar 31, 2024

bors added a commit to rust-lang-ci/rust that referenced this pull request

Mar 31, 2024 
…kingjubilee

Rollup of 5 pull requests

Successful merges:

 - rust-lang#123180 (Rewrite `core-no-fp-fmt-parse` test in Rust)
 - rust-lang#123267 (std::thread: adding get_name haiku implementation.)
 - rust-lang#123268 (warn against implementing Freeze)
 - rust-lang#123271 (doc: describe panic conditions for SliceIndex implementations)
 - rust-lang#123295 (add myself to compiler review rotation)

r? `@ghost`
`@rustbot` modify labels: rollup

rust-timer added a commit to rust-lang-ci/rust that referenced this pull request

Mar 31, 2024 
Rollup merge of rust-lang#123271 - JaniM:janim/sliceindex-doc, r=Nilstrieb

doc: describe panic conditions for SliceIndex implementations

Implementation note: The most probable place for users to find the documentation is at https://doc.rust-lang.org/std/slice/trait.SliceIndex.html

On that page, documentation added to specific methods will not be visible. As such, I opted to add the comments to the impl blocks directly.

Helps with rust-lang#121568.

@JaniM JaniM deleted the janim/sliceindex-doc branch

March 31, 2024 22:47