Skip to content

Escape item search summaries #87331

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

Merged
merged 1 commit into from
Jul 25, 2021
Merged

Conversation

camelid
Copy link
Member

@camelid camelid commented Jul 21, 2021

I noticed that Pin::new()'s search summary looked off, and I realized
that the reason is that it has inline code containing Pin<P>, which is
not escaped and thus renders as a paragraph tag!

@camelid camelid added A-rustdoc-search Area: Rustdoc's search feature T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jul 21, 2021
@rust-highfive
Copy link
Contributor

r? @GuillaumeGomez

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

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 21, 2021
@camelid
Copy link
Member Author

camelid commented Jul 21, 2021

Test case

/// Construct a new `Pin<P>` with this function.
pub fn new() {}

Output (before)

image

Output (after)

image

@rust-log-analyzer

This comment has been minimized.

@camelid camelid force-pushed the summary-escaping branch from af606b1 to 1ac65cb Compare July 21, 2021 01:49
@camelid camelid force-pushed the summary-escaping branch from 1ac65cb to bab60b2 Compare July 22, 2021 19:35
@rust-log-analyzer

This comment has been minimized.

@camelid camelid force-pushed the summary-escaping branch from bab60b2 to 343a6bc Compare July 22, 2021 20:12
@rust-log-analyzer

This comment has been minimized.

@camelid camelid force-pushed the summary-escaping branch 3 times, most recently from e9af1f8 to 8c816dd Compare July 24, 2021 22:25
@GuillaumeGomez
Copy link
Member

Thanks! r=me once CI pass.

@camelid
Copy link
Member Author

camelid commented Jul 24, 2021

@bors r=@GuillaumeGomez

@bors
Copy link
Collaborator

bors commented Jul 24, 2021

📌 Commit 8c816dd4d1ec36050baf8195078267232e8df2a5 has been approved by GuillaumeGomez

@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 Jul 24, 2021
@camelid
Copy link
Member Author

camelid commented Jul 25, 2021

Weird... CI passed but I had accidentally removed the import of Escape. Bug in CI?

EDIT: It looks like that import was added after the merge-base of this PR, and because CI merges before testing, it was as if the import was appearing in this PR magically 😅

@camelid camelid force-pushed the summary-escaping branch from 8c816dd to 95a9d20 Compare July 25, 2021 00:12
I noticed that `Pin::new()`'s search summary looked off, and I realized
that the reason is that it has inline code containing `Pin<P>`, which is
not escaped and thus renders as a paragraph tag!
@camelid camelid force-pushed the summary-escaping branch from 95a9d20 to 4ad2d68 Compare July 25, 2021 00:15
@camelid
Copy link
Member Author

camelid commented Jul 25, 2021

@bors r=@GuillaumeGomez

@bors
Copy link
Collaborator

bors commented Jul 25, 2021

📌 Commit 4ad2d68 has been approved by GuillaumeGomez

@bors
Copy link
Collaborator

bors commented Jul 25, 2021

⌛ Testing commit 4ad2d68 with merge f63ec77...

@bors
Copy link
Collaborator

bors commented Jul 25, 2021

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing f63ec77 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Jul 25, 2021
@bors bors merged commit f63ec77 into rust-lang:master Jul 25, 2021
@rustbot rustbot added this to the 1.56.0 milestone Jul 25, 2021
@camelid camelid deleted the summary-escaping branch July 25, 2021 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-search Area: Rustdoc's search feature merged-by-bors This PR was explicitly merged by bors. 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.

6 participants