-
Notifications
You must be signed in to change notification settings - Fork 13k
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: Add tooltips to sidebar (v3) #20221
Conversation
(rust_highfive has picked a reviewer for you, use r? to override) |
Re-assigning to @alexcrichton since he was cited in the text (or @steveklabnik ) |
Needs a rebase |
1ee163c
to
e788b09
Compare
rebased |
'"' => result.push_str("""), | ||
'\'' => result.push_str("'"), | ||
_ => result.push(c), | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could this use rustdoc::html::escape
instead of duplicating logic?
e788b09
to
d22f03a
Compare
d22f03a
to
2b11a80
Compare
@alexcrichton I've addressed all your review comments in latest commit, and rebased. Sorry for the delay. |
⌛ Testing commit 2b11a80 with merge 9a0042b... |
💔 Test failed - auto-win-32-nopt-t |
@bors: retry |
⌛ Testing commit 2b11a80 with merge 65cc262... |
💔 Test failed - auto-win-32-nopt-t |
@bors: retry |
⌛ Testing commit 2b11a80 with merge cb5b1f1... |
💔 Test failed - auto-mac-64-nopt-t |
@bors: retry |
This pull request add tooltips to most links of sidebar. The tooltips display "summary line" of items' document. Some lengthy/annoying raw markdown code are eliminated, such as links and headers. - `[Rust](http://rust-lang.org)` displays as `Rust` (no URLs) - `# header` displays as `header` (no `#`s) Some inline spans, e.g. ``` `code` ``` and ```*emphasis*```, are kept as they are, for better readable. I've make sure `&` `'` `"` `<` and `>` are properly displayed in tooltips, for example, `&'a Option<T>`. Online preview: http://liigo.com/tmp/tooltips/std/index.html @alexcrichton @steveklabnik since you have reviewed my previous ([v1](https://github.com/rust-lang/rust/pull/13014),[v2](https://github.com/rust-lang/rust/pull/16448)) PRs of this serise, which have been closed for technical reasons. Thank you.
This pull request add tooltips to most links of sidebar.
The tooltips display "summary line" of items' document.
Some lengthy/annoying raw markdown code are eliminated, such as links and headers.
[Rust](http://rust-lang.org)
displays asRust
(no URLs)# header
displays asheader
(no#
s)Some inline spans, e.g.
code
and*emphasis*
, are kept as they are, for better readable.I've make sure
&
'
"
<
and>
are properly displayed in tooltips, for example,&'a Option<T>
.Online preview: http://liigo.com/tmp/tooltips/std/index.html
@alexcrichton @steveklabnik since you have reviewed my previous (v1,v2) PRs of this serise, which have been closed for technical reasons. Thank you.