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: add tooltips to sidebar #16448

Closed
wants to merge 1 commit into from

Conversation

liigo
Copy link
Contributor

@liigo liigo commented Aug 12, 2014

This PR add tooltip to most every links in sidebar, showing its primary description.

Online preview:
http://liigo.com/tmp/rust/std/index.html
http://liigo.com/tmp/rust/std/str/trait.StrSlice.html

@steveklabnik
Copy link
Member

I like this, though it shows the raw Markdown, which is awkward.

@liigo
Copy link
Contributor Author

liigo commented Aug 13, 2014

@steveklabnik Are you referring the

`code` in docs

and # header ?

For the first one, I think it's still readable, better than "code in docs". What style are you like to change to? For the second one, there are only several # header style in tooltips, and there are come from search-index.js, which is out of this PR, but i'd like seeing it be changed later.

@steveklabnik
Copy link
Member

I'm referring to the fact that the tooltips contain the literal text foo bar [some link](https://whatever.com/whatever), as well as code in docs and #header stuff.

@liigo
Copy link
Contributor Author

liigo commented Aug 13, 2014

@steveklabnik Oh, yes, there are markdown links [title](url) and [title][ref]. Perhaps we can fix this by removing these links in brief docs?

@liigo
Copy link
Contributor Author

liigo commented Aug 18, 2014

cc @pcwalton @alexcrichton @brson
Currently, I don't know how to do with these Markdown codes, which come from doc-comments. Parse it or just remove it (off brief docs)?

@alexcrichton
Copy link
Member

Closing due to inactivity, but feel free to reopen with a rebase!

matthiaskrgr pushed a commit to matthiaskrgr/rust that referenced this pull request Feb 5, 2024
minor: correct typos

I use [crate-ci/typos](https://github.com/crate-ci/typos) to check typos in codebase, if it's ok with you, I'd like to add a typo check CI using [typos](https://github.com/crate-ci/typos) (with Apache-2.0, MIT licenses).

BTW, we can add a [_typos.toml](https://github.com/crate-ci/typos/blob/master/docs/reference.md) as white list for some intentional typos
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants