Skip to content

Rustdoc search results ignore markdown formatting #32040

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

Closed
cmbrandenburg opened this issue Mar 4, 2016 · 3 comments · Fixed by #77686
Closed

Rustdoc search results ignore markdown formatting #32040

cmbrandenburg opened this issue Mar 4, 2016 · 3 comments · Fixed by #77686
Assignees
Labels
C-bug Category: This is a bug. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@cmbrandenburg
Copy link
Contributor

Using Rust 1.7, a rustdoc search result shown in the browser (as a consequence of pressing the S key and entering a search term) displays raw Markdown, not formatted text. For example, take the standard library documentation, press S, then enter the search term trait: Neg, and the search result will show this text verbatim:

The `Neg` trait is used to specify the functionality of unary `-`.

Whereas, it should be formatted—i.e., no backticks.

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Mar 4, 2016
@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-bug Category: This is a bug. label Jul 24, 2017
@steveklabnik
Copy link
Member

Triage: no change

@camelid
Copy link
Member

camelid commented Sep 11, 2020

triage: still no change

@camelid
Copy link
Member

camelid commented Oct 5, 2020

I think I have a simple way to solve some cases of this, so I'm assigning myself since this has been open for a long time without a fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
5 participants