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.

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

Escaped HTML present in doc comments gets rendered in search results #31059

Closed
jdm opened this issue Jan 20, 2016 · 3 comments · Fixed by #31626
Closed

Escaped HTML present in doc comments gets rendered in search results #31059

jdm opened this issue Jan 20, 2016 · 3 comments · Fixed by #31626
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jdm
Copy link
Contributor

jdm commented Jan 20, 2016

By escaped, I mean stuff like

/// stuff for `<iframe>`

which renders fine in non-search listings (it looks like <iframe>, instead of a literal iframe element on the page).
@jdm jdm added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. I-papercut labels Jan 20, 2016
@jdm jdm mentioned this issue Jan 20, 2016
Closed
@steveklabnik
Copy link
Member

I thought we had an issue for this, but cannot find it.

@frewsxcv
Copy link
Member

Relevant to inline summary rendering: #25787

@mitaa
Copy link
Contributor

mitaa commented Feb 12, 2016

Search result descriptions aren't markdown rendered and read/written unaltered from the search-index to the page.

Should these descriptions be markdown rendered or html escaped (#18419)?

@mitaa mitaa mentioned this issue Feb 13, 2016
Merged
bors added a commit that referenced this issue Feb 14, 2016
@bors
Auto merge of #31626 - mitaa:rdoc-srch-escape, r=alexcrichton
f3619ce 
Maybe they should be Markdown rendered instead, though that doesn't really seem to work all that well.

fixes #31059

r? @alexcrichton
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Escape search-index item descriptions mitaa/rust
4 participants
@jdm @steveklabnik @frewsxcv @mitaa