Skip to content

Update doc for PhantomData to match code example #102673

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
Merged
merged 1 commit into from
May 15, 2023
Merged

Update doc for PhantomData to match code example #102673

merged 1 commit into from
May 15, 2023

Conversation

lukas-code
Copy link
Member

@lukas-code lukas-code commented Oct 4, 2022 •
edited
Loading

After #106621, there is no longer a T: 'a annotation in the doc example, so update the text to match the code.

@rust-highfive
Copy link
Contributor

r? @joshtriplett

(rust-highfive has picked a reviewer for you, use r? to override)

@rustbot
Copy link
Collaborator

rustbot commented Oct 4, 2022

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

@rustbot rustbot added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Oct 4, 2022
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 4, 2022
@lukas-code lukas-code changed the title Infered lifetimes cleanup Inferred lifetimes cleanup Oct 4, 2022
@bors
Copy link
Collaborator

bors commented Nov 28, 2022

☔ The latest upstream changes (presumably #102991) made this pull request unmergeable. Please resolve the merge conflicts.

@wesleywiser wesleywiser removed the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Dec 1, 2022
@bors
Copy link
Collaborator

bors commented Dec 28, 2022

☔ The latest upstream changes (presumably #106209) made this pull request unmergeable. Please resolve the merge conflicts.

@bors
Copy link
Collaborator

bors commented Dec 29, 2022

☔ The latest upstream changes (presumably #106228) made this pull request unmergeable. Please resolve the merge conflicts.

@bors
Copy link
Collaborator

bors commented Dec 31, 2022

☔ The latest upstream changes (presumably #106324) made this pull request unmergeable. Please resolve the merge conflicts.

@bors
Copy link
Collaborator

bors commented Jan 14, 2023

☔ The latest upstream changes (presumably #106833) made this pull request unmergeable. Please resolve the merge conflicts.

@SmiteWindows
Copy link

@lukas-code src/test ->tests

@bors
Copy link
Collaborator

bors commented Jan 29, 2023

☔ The latest upstream changes (presumably #106253) made this pull request unmergeable. Please resolve the merge conflicts.

@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 May 14, 2023
@anden3
Copy link
Contributor

anden3 commented May 14, 2023

Hello @lukas-code! I noticed this PR has some merge conflicts, what's the status of it?

@lukas-code
Copy link
Member Author

This has bitrotted pretty hard and will probably be a pain to rebase. The main motivation for this PR is this documentation fix: 82de260230f93af5806440ab305e18e07bfdb0c8, which is pretty small. The rest is just updating std to be consistent with this and a probably redundant UI test (421a151f3fe478d092146cee7c94d1eb2cd04386) to confirm that the doc change is actually correct.

I can rebase to only keep 82de260230f93af5806440ab305e18e07bfdb0c8 (and optionally 421a151f3fe478d092146cee7c94d1eb2cd04386), which will reduce bitrot and make this easy to review.

@anden3
Copy link
Contributor

anden3 commented May 14, 2023

Sounds like a good idea!

@lukas-code lukas-code force-pushed the infered-lifetimes branch from 3480dba to 3d02aa8 Compare May 14, 2023 15:02
@lukas-code
Copy link
Member Author

OK, turns out the relevant changes already landed in 4e7c14f, so this went from "impossible to review" to "tiny wording change" real quick.

@rustbot ready

r? docs

@rustbot rustbot removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label May 14, 2023
@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 14, 2023
@rustbot rustbot assigned ehuss and unassigned joshtriplett May 14, 2023
@lukas-code lukas-code changed the title Inferred lifetimes cleanup Update doc for PhantomData to match code example May 14, 2023
@ehuss
Copy link
Contributor

ehuss commented May 14, 2023

Thanks!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented May 14, 2023

📌 Commit 3d02aa8 has been approved by ehuss

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 May 14, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request May 15, 2023
@matthiaskrgr
Rollup merge of rust-lang#102673 - lukas-code:infered-lifetimes, r=ehuss
af2182c 
Update doc for `PhantomData` to match code example

After rust-lang#106621, there is no longer a `T: 'a` annotation in the doc example, so update the text to match the code.
@matthiaskrgr matthiaskrgr mentioned this pull request May 15, 2023
Closed
@matthiaskrgr matthiaskrgr mentioned this pull request May 15, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request May 15, 2023
@bors
Auto merge of rust-lang#111585 - matthiaskrgr:rollup-468pykj, r=matth…
2913ad6 
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#102673 (Update doc for `PhantomData` to match code example)
 - rust-lang#111531 (Fix ice caused by shorthand fields in NoFieldsForFnCall)
 - rust-lang#111547 (Start node has no immediate dominator)
 - rust-lang#111548 (add util function to TokenStream to eliminate some clones)
 - rust-lang#111560 (Simplify find_width_of_character_at_span.)
 - rust-lang#111569 (Appease lints)
 - rust-lang#111581 (Fix some misleading and copy-pasted `Pattern` examples)
 - rust-lang#111582 ((docs) Change "wanting" to "want")

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 28bc874 into rust-lang:master May 15, 2023
@rustbot rustbot added this to the 1.71.0 milestone May 15, 2023
@lukas-code lukas-code deleted the infered-lifetimes branch May 15, 2023 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@ehuss ehuss

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

Milestone

1.71.0

Development

Successfully merging this pull request may close these issues.

9 participants

@lukas-code @rust-highfive @rustbot @bors @SmiteWindows @anden3 @ehuss @joshtriplett @wesleywiser