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.

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

Document rustc_index::vec::IndexVec #93792

Closed
pierwill opened this issue Feb 9, 2022 · 11 comments
Closed

Document rustc_index::vec::IndexVec #93792

pierwill opened this issue Feb 9, 2022 · 11 comments
Assignees
@dev-ardi
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@pierwill
Copy link
Member

pierwill commented Feb 9, 2022 •
edited by rustbot
Loading

rustc_index::vec::IndexVec is used in 103 files in the compiler, yet it lacks documentation.
@rustbot rustbot added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Feb 9, 2022
@mfrw
Copy link
Contributor

mfrw commented Feb 9, 2022

@rustbot claim

@pnkfelix
Copy link
Member

pnkfelix commented Feb 9, 2022

@mfrw happy to see you claim this. I figure I'll just note: If you're wondering about the motivation, it wouldn't hurt to review the commit that introduced the IndexVec and Idx abstractions: bc1eb67

@mfrw
Copy link
Contributor

mfrw commented Feb 9, 2022 •
edited
Loading

@mfrw happy to see you claim this. I figure I'll just note: If you're wondering about the motivation, it wouldn't hurt to review the commit that introduced the IndexVec and Idx abstractions: bc1eb67

Appreciate the pointer :)
Thank you

@JKAnderson409
Copy link

@mfrw Can I claim this one?

@mfrw
Copy link
Contributor

mfrw commented Mar 15, 2022

@mfrw Can I claim this one?

Please do.. I am not getting the time at the moment

@JKAnderson409
Copy link

Thanks! @rustbot claim

@rustbot rustbot assigned JKAnderson409 and unassigned mfrw Mar 15, 2022
@pierwill pierwill mentioned this issue Jul 21, 2022
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jul 21, 2022
@matthiaskrgr
Rollup merge of rust-lang#99557 - pierwill:patch-6, r=tmiasko
0a1b6ed 
Edit `rustc_index::vec::IndexVec::pick3_mut` docs

Clarify when this method will panic.

Part of rust-lang#93792.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jul 21, 2022
@matthiaskrgr
Rollup merge of rust-lang#99557 - pierwill:patch-6, r=tmiasko
14c385d 
Edit `rustc_index::vec::IndexVec::pick3_mut` docs

Clarify when this method will panic.

Part of rust-lang#93792.
@pqcfox
Copy link

pqcfox commented Feb 12, 2023

@rustbot claim

@pqcfox
Copy link

pqcfox commented Feb 14, 2023

One quick question re: IndexVec so I can help document it better--is the purpose of _marker: PhantomData<fn(&I)> to suggest to the drop checker that an instance of Idx::index in particular may drop at the same time as IndexVec? (Apologies for the simple question, I'm still getting my footing with Rust.)

Thanks!

@dev-ardi
Copy link
Contributor

@rustbot claim

@dev-ardi dev-ardi mentioned this issue Jan 10, 2024
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jan 26, 2024
@matthiaskrgr
Rollup merge of rust-lang#119800 - dev-ardi:tmp, r=wesleywiser
9000bf6 
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 issue Jan 26, 2024
@matthiaskrgr
Rollup merge of rust-lang#119800 - dev-ardi:tmp, r=wesleywiser
b31bf24 
Document `rustc_index::vec::IndexVec`

Document a few of the methods.

Part of rust-lang#93792.
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Jan 27, 2024
@rust-timer
Unrolled build for rust-lang#119800
4058e29 
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.
@dev-ardi dev-ardi mentioned this issue Mar 5, 2024
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 6, 2024
@matthiaskrgr
Rollup merge of rust-lang#122015 - dev-ardi:master, r=nnethercote
e5503b6 
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 issue Mar 6, 2024
@matthiaskrgr
Rollup merge of rust-lang#122015 - dev-ardi:master, r=nnethercote
ebd3a4f 
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 issue Mar 6, 2024
@matthiaskrgr
Rollup merge of rust-lang#122015 - dev-ardi:master, r=nnethercote
7e3a2a0 
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 issue Mar 6, 2024
@matthiaskrgr
Rollup merge of rust-lang#122015 - dev-ardi:master, r=nnethercote
d451faa 
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 issue Mar 7, 2024
@rust-timer
Unrolled build for rust-lang#122015
9c2a5ed 
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
Copy link
Contributor

dev-ardi commented Mar 7, 2024

Anything that lacks clarification or this can be closed

@Dylan-DPC
Copy link
Member

Closing this as #122015 should satisfy it (next time you can mention fixes or closes to autoclose the issue once the pr is merged if it there is nothing left to add to the issue)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dev-ardi dev-ardi

Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@pnkfelix @mfrw @pqcfox @pierwill @JKAnderson409 @dev-ardi @rustbot @Dylan-DPC