Skip to content

cleanup summery line docs - #17473

Closed
liigo wants to merge 4 commits into
rust-lang:masterfrom
liigo:cleanup-summery-line-docs
Closed

cleanup summery line docs#17473
liigo wants to merge 4 commits into
rust-lang:masterfrom
liigo:cleanup-summery-line-docs

Conversation

@liigo

@liigo liigo commented Sep 23, 2014

Copy link
Copy Markdown
Contributor

Move links in summery line docs to following detail docs.

Fixes #16928

@rust-highfive

Copy link
Copy Markdown
Contributor

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.

Comment thread src/librand/isaac.rs Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not correct, it is a citation, not a link. (The link "URL" is a nonsense URL.)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@huonw Good idea! I'll update, thank you!

@liigo

liigo commented Sep 23, 2014

Copy link
Copy Markdown
Contributor Author

Hopefully this will speed up landing #16448

Comment thread src/liballoc/lib.rs Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the # heading removed?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to try avoid showing raw markdown code in tooltips: #16448

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm OK with #, will get it back, and handle it inside #16448.

@liigo

liigo commented Sep 25, 2014

Copy link
Copy Markdown
Contributor Author

Updated. Move links in summery line docs to following detail docs, and restore #s.
Thank you @huonw and @alexcrichton for you good advising!

@liigo

liigo commented Sep 25, 2014

Copy link
Copy Markdown
Contributor Author

Not ready to merge. I need double check other summery lines that has links too.

@liigo

liigo commented Sep 25, 2014

Copy link
Copy Markdown
Contributor Author

@huonw @alexcrichton r?

@alexcrichton

Copy link
Copy Markdown
Member

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?

@steveklabnik

Copy link
Copy Markdown
Contributor

Yeah, I would prefer a rustdoc-level fix. Especially as people write their
own libraries.

@liigo

liigo commented Sep 26, 2014

Copy link
Copy Markdown
Contributor Author

Closing. I'll try to fix that at the rustdoc level. Thank you @alexcrichton

@liigo liigo closed this Sep 26, 2014
lnicola pushed a commit to lnicola/rust that referenced this pull request Jun 23, 2024
internal: Tidy up generics handling in hir-ty a bit
flip1995 pushed a commit to flip1995/rust that referenced this pull request Aug 1, 2026
…ated code (rust-lang#17473)

This fixes a false positive where `no_effect_underscore_binding` fired
on
`let _x = _x;` bindings created by proc macros such as `no_panic`. The
user
has no way to change the generated code, so the lint should stay quiet
there.

The check only looked at the pattern span, which still points at the
original
identifier when a proc macro reuses the user's tokens, so the lint
slipped
through. It now also checks whether the whole `let` statement comes from
a
macro expansion, and whether the initializer comes from a proc macro.
This
matches how the sibling `redundant_locals` lint handles the same `let x
= x;`
shape.

Added a regression test covering a normal binding (still linted) and
proc-macro generated bindings (not linted).

fixes rust-lang/rust-clippy#17430

changelog: [`no_effect_underscore_binding`]: don't lint bindings
generated by proc macros
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.

try avoid using markdown code in summary line docs

6 participants