Replace a long inline "autoref" comment with method docs by Zalathar · Pull Request #127556 · rust-lang/rust (original) (raw)

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 andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation9 Commits1 Checks6 Files changed

Conversation

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

This comment has two problems:

• It is very long, making the flow of the enclosing method hard to follow.
• It starts by talking about an autoref flag that hasn't existed since Enable NLL migrate mode on the 2015 edition #59114.
  • This makes it hard to trust that the information in the comment is accurate or relevant, even though much of it still seems to be true.

This PR therefore replaces the long inline comment with a revised doc comment on bind_matched_candidate_for_guard, and some shorter inline comments.

For readers who want more historical context, we also link to the PR that added the old comment, and the PR that removed the autoref flag.

r? @lcnr

rustbot has assigned @lcnr.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

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

Jul 10, 2024

Some changes occurred in match lowering

cc @Nadrieril

This comment has been minimized.

Zalathar changed the titleReplace a long inline "autoref" comment with some historical links Replace a long inline "autoref" comment with method docs

Jul 10, 2024

This comment has been minimized.

This comment has two problems:

• It is very long, making the flow of the enclosing method hard to follow.
• It starts by talking about an autoref flag that hasn't existed since rust-lang#59114.

This PR therefore replaces the long inline comment with a revised doc comment on bind_matched_candidate_for_guard, and some shorter inline comments.

For readers who want more historical context, we also link to the PR that added the old comment, and the PR that removed the autoref flag.

Looks good!

@bors r+ rollup

📌 Commit 83e1efb has been approved by Nadrieril

It is now in the queue for this repository.

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 19, 2024

tgross35 added a commit to tgross35/rust that referenced this pull request

Jul 19, 2024

Replace a long inline "autoref" comment with method docs

This comment has two problems:

• It is very long, making the flow of the enclosing method hard to follow.
• It starts by talking about an autoref flag that hasn't existed since rust-lang#59114.
  • This makes it hard to trust that the information in the comment is accurate or relevant, even though much of it still seems to be true.

This PR therefore replaces the long inline comment with a revised doc comment on bind_matched_candidate_for_guard, and some shorter inline comments.

For readers who want more historical context, we also link to the PR that added the old comment, and the PR that removed the autoref flag.

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

Jul 20, 2024

Rollup of 8 pull requests

Successful merges:

• rust-lang#123196 (Add Process support for UEFI)
• rust-lang#127523 (Migrate dump-ice-to-disk and panic-abort-eh_frame run-make tests to rmake)
• rust-lang#127556 (Replace a long inline "autoref" comment with method docs)
• rust-lang#127693 (Migrate crate-hash-rustc-version to rmake)
• rust-lang#127866 (Conditionally build wasm-component-ld )
• rust-lang#127918 (Safely enforce thread name requirements)
• rust-lang#127948 (fixes panic error index out of bounds in conflicting error)
• rust-lang#127980 (Avoid ref when using format! in compiler)

r? @ghost @rustbot modify labels: rollup

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

Jul 20, 2024

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

Jul 20, 2024

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

Jul 20, 2024

Rollup merge of rust-lang#127556 - Zalathar:autoref, r=Nadrieril

Replace a long inline "autoref" comment with method docs

This comment has two problems:

• It is very long, making the flow of the enclosing method hard to follow.
• It starts by talking about an autoref flag that hasn't existed since rust-lang#59114.
  • This makes it hard to trust that the information in the comment is accurate or relevant, even though much of it still seems to be true.

This PR therefore replaces the long inline comment with a revised doc comment on bind_matched_candidate_for_guard, and some shorter inline comments.

For readers who want more historical context, we also link to the PR that added the old comment, and the PR that removed the autoref flag.

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.