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

rustdoc: escape GAT args in more cases #109919

Merged
merged 1 commit into from
Apr 4, 2023

Conversation

fmease
Copy link
Member

@fmease fmease commented Apr 4, 2023

Fixes #109488.

Previously we printed the unescaped form of GAT arguments not only when f.alternate() was true but also when we failed to compute the URL of the trait associated with the type projection, i.e. when href(…) returned an Err(_).

In this PR the argument printing logic is entirely separate from the link resolution code above as it should be.
Further, we now only try to compute the URL if the HTML format was requested with !f.alternate(). Before, we would sometimes compute the href only to throw it away later.

@rustbot
Copy link
Collaborator

rustbot commented Apr 4, 2023

r? @notriddle

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Apr 4, 2023
@notriddle
Copy link
Contributor

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 4, 2023

📌 Commit 6567bc9 has been approved by notriddle

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 Apr 4, 2023
aliemjay added a commit to aliemjay/rust that referenced this pull request Apr 4, 2023
…=notriddle

rustdoc: escape GAT args in more cases

Fixes rust-lang#109488.

Previously we printed the *un*escaped form of GAT arguments not only when `f.alternate()` was true but *also* when we failed to compute the URL of the trait associated with the type projection, i.e. when `href(…)` returned an `Err(_)`.

In this PR the argument printing logic is entirely separate from the above link resolution code as it should be.
Further, we now only try to compute the URL if the HTML format was requested with `!f.alternate()`. Before, we would sometimes compute the `href` only to throw it away later.
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 4, 2023
…mpiler-errors

Rollup of 9 pull requests

Successful merges:

 - rust-lang#109723 (Pull some tuple variant fields out into their own struct)
 - rust-lang#109838 (Fix `non_exhaustive_omitted_patterns` lint span)
 - rust-lang#109901 (Enforce VarDebugInfo::Place in MIR validation.)
 - rust-lang#109913 (Doc-comment  `IndexVec::from_elem` and use it in a few more places)
 - rust-lang#109914 (Emit feature error for parenthesized generics in associated type bounds)
 - rust-lang#109919 (rustdoc: escape GAT args in more cases)
 - rust-lang#109937 (Don't collect return-position impl traits for documentation)
 - rust-lang#109938 (Move a const-prop-lint specific hack from mir interpret to const-prop-lint and make it fallible)
 - rust-lang#109940 (Add regression test for rust-lang#93911)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 72e535e into rust-lang:master Apr 4, 2023
@rustbot rustbot added this to the 1.70.0 milestone Apr 4, 2023
@fmease fmease deleted the rustdoc-fix-issue-109488 branch April 4, 2023 18:58
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-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rustdoc does not escape GAT arguments when it fails to compute the href link for the trait
4 participants