Skip to content
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.

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

Document rustc_index::vec::IndexVec #119800

Merged
merged 4 commits into from
Jan 27, 2024
Merged

Document rustc_index::vec::IndexVec #119800

merged 4 commits into from
Jan 27, 2024

Conversation

dev-ardi
Copy link
Contributor

@dev-ardi dev-ardi commented Jan 10, 2024

Document a few of the methods.

Part of #93792.

@rustbot
Copy link
Collaborator

rustbot commented Jan 10, 2024

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @wesleywiser (or someone else) soon.

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-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Jan 10, 2024
@rust-log-analyzer

This comment has been minimized.

/// This allows to index the IndexVec with the new index type:
///
/// ```
/// use crate as rustc_index;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wasn't able to get this to work because I couldn't import this.

@rust-log-analyzer

This comment has been minimized.

compiler/rustc_index/src/vec.rs Outdated Show resolved Hide resolved
compiler/rustc_index/src/vec.rs Show resolved Hide resolved
compiler/rustc_index/src/vec.rs Outdated Show resolved Hide resolved
compiler/rustc_index/src/vec.rs Outdated Show resolved Hide resolved
@rust-log-analyzer

This comment has been minimized.

Co-authored-by: Wesley Wiser <wwiser@gmail.com>
@wesleywiser
Copy link
Member

Thanks @dev-ardi! Always nice to see docs improvements 👍

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jan 26, 2024

📌 Commit 00ada8e has been approved by wesleywiser

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 Jan 26, 2024
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jan 26, 2024
Document `rustc_index::vec::IndexVec`

Document a few of the methods.

Part of rust-lang#93792.
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 26, 2024
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#103522 (stabilise array methods)
 - rust-lang#113489 (impl `From<&[T; N]>` for `Cow<[T]>`)
 - rust-lang#119562 (Rename `pointer` field on `Pin`)
 - rust-lang#119800 (Document `rustc_index::vec::IndexVec`)
 - rust-lang#120368 (llvm-wrapper: remove llvm 12 hack)
 - rust-lang#120378 (always normalize `LoweredTy` in the new solver)
 - rust-lang#120382 (Classify closure arguments in refutable pattern in argument error)
 - rust-lang#120389 (Add fmease to the compiler review rotation)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 27, 2024
…iaskrgr

Rollup of 12 pull requests

Successful merges:

 - rust-lang#103522 (stabilise array methods)
 - rust-lang#113489 (impl `From<&[T; N]>` for `Cow<[T]>`)
 - rust-lang#119342 (Emit suggestion when trying to write exclusive ranges as `..<`)
 - rust-lang#119562 (Rename `pointer` field on `Pin`)
 - rust-lang#119800 (Document `rustc_index::vec::IndexVec`)
 - rust-lang#120205 (std: make `HEAP` initializer never inline)
 - rust-lang#120277 (Normalize field types before checking validity)
 - rust-lang#120311 (core: add `From<core::ascii::Char>` implementations)
 - rust-lang#120366 (mark a doctest with UB as no_run)
 - rust-lang#120378 (always normalize `LoweredTy` in the new solver)
 - rust-lang#120382 (Classify closure arguments in refutable pattern in argument error)
 - rust-lang#120389 (Add fmease to the compiler review rotation)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit b31bf24 into rust-lang:master Jan 27, 2024
11 checks passed
@rustbot rustbot added this to the 1.77.0 milestone Jan 27, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jan 27, 2024
Rollup merge of rust-lang#119800 - dev-ardi:tmp, r=wesleywiser

Document `rustc_index::vec::IndexVec`

Document a few of the methods.

Part of rust-lang#93792.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 6, 2024
Add better explanation for `rustc_index::IndexVec`

I feel like I didn't do a great job explaining what this does in rust-lang#119800, so this PR tries to give an example of why and how you would use it.

Addresses rust-lang#93792.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 6, 2024
Add better explanation for `rustc_index::IndexVec`

I feel like I didn't do a great job explaining what this does in rust-lang#119800, so this PR tries to give an example of why and how you would use it.

Addresses rust-lang#93792.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 6, 2024
Add better explanation for `rustc_index::IndexVec`

I feel like I didn't do a great job explaining what this does in rust-lang#119800, so this PR tries to give an example of why and how you would use it.

Addresses rust-lang#93792.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 6, 2024
Add better explanation for `rustc_index::IndexVec`

I feel like I didn't do a great job explaining what this does in rust-lang#119800, so this PR tries to give an example of why and how you would use it.

Addresses rust-lang#93792.
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Mar 7, 2024
Rollup merge of rust-lang#122015 - dev-ardi:master, r=nnethercote

Add better explanation for `rustc_index::IndexVec`

I feel like I didn't do a great job explaining what this does in rust-lang#119800, so this PR tries to give an example of why and how you would use it.

Addresses rust-lang#93792.
@dev-ardi dev-ardi deleted the tmp branch May 22, 2024 10:10
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-compiler Relevant to the compiler 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