Improve syntax::ast::* type docs (examples, etc)
#34449
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @pnkfelix (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
| @@ -178,9 +178,11 @@ pub struct LifetimeDef { | |||
| pub bounds: Vec<Lifetime> | |||
| } | |||
|
|
|||
| /// A "Path" is essentially Rust's notion of a name; for instance: | |||
| /// std::cmp::PartialEq . It's represented as a sequence of identifiers, | |||
| /// A "Path" is essentially Rust's notion of a name. | |||
There was a problem hiding this comment.
Can you add an empty line here (well, one that starts with /// actually), so rustdoc can pick this first sentence for use as a short description?
|
Thanks for your comments, @killercup! |
| /// | ||
| /// E.g. `0...10 => { println!("match!") }` as in | ||
| /// | ||
| /// ```rust, ignore |
There was a problem hiding this comment.
The whitespace before "ignore" is useless.
|
👍 |
|
@bors: r+ rollup |
|
📌 Commit 32ef890 has been approved by |
Improve `syntax::ast::*` type docs (examples, etc) An attempt at making the public types in `syntax::ast` a bit more approachable. [#rust-doc-days](https://facility9.com/2016/06/announcing-rust-doc-days/)
An attempt at making the public types in
syntax::asta bit more approachable.#rust-doc-days