cleanup summery line docs #17473
cleanup summery line docs #17473
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @alexcrichton (or someone else) soon. |
| @@ -20,14 +20,14 @@ static RAND_SIZE_LEN: u32 = 8; | |||
| static RAND_SIZE: u32 = 1 << (RAND_SIZE_LEN as uint); | |||
| static RAND_SIZE_UINT: uint = 1 << (RAND_SIZE_LEN as uint); | |||
|
|
|||
| /// A random number generator that uses the ISAAC algorithm[1]. | |||
| /// A random number generator that uses the [ISAAC] algorithm. | |||
There was a problem hiding this comment.
This is not correct, it is a citation, not a link. (The link "URL" is a nonsense URL.)
There was a problem hiding this comment.
@huonw Basically the same as before (both not a link). I'll revert this change if you still care it.
Before(nightly): http://doc.rust-lang.org/nightly/rand/isaac/struct.IsaacRng.html
After this change: http://liigo.com/tmp/summery-line/rand/isaac/struct.IsaacRng.html
There was a problem hiding this comment.
I would prefer the [1] numbers. Feel free to move it to the first mention of ISAAC in the next paragraph though. (i.e. so that is not in the summary.)
There was a problem hiding this comment.
@huonw Good idea! I'll update, thank you!
|
Hopefully this will speed up landing #16448 |
| @@ -8,7 +8,7 @@ | |||
| // option. This file may not be copied, modified, or distributed | |||
| // except according to those terms. | |||
|
|
|||
| //! # The Rust core allocation library | |||
| //! The Rust core allocation library | |||
There was a problem hiding this comment.
Why is the # heading removed?
There was a problem hiding this comment.
Just to try avoid showing raw markdown code in tooltips: #16448
There was a problem hiding this comment.
The current look-and-feel of the headings on the index pages is about what we would want, so I don't think we should compromise the headings.
There was a problem hiding this comment.
I'm OK with #, will get it back, and handle it inside #16448.
|
Updated. Move links in summery line docs to following detail docs, and restore |
|
Not ready to merge. I need double check other summery lines that has links too. |
|
Is the purpose of this PR to move out all markdown from the one-line summary docs shown? If so, #16448 doesn't seem like a particularly compelling reason as I'm sure this is quite common throughout many rust libraries and this will surely come up again. Would it be possible to fix this at the rustdoc level for #16448? |
|
Yeah, I would prefer a rustdoc-level fix. Especially as people write their |
|
Closing. I'll try to fix that at the rustdoc level. Thank you @alexcrichton |
internal: Tidy up generics handling in hir-ty a bit
Move links in summery line docs to following detail docs.
Fixes #16928