Skip to content

Improve syntax::ast::* type docs (examples, etc) #34449

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

Improve syntax::ast::* type docs (examples, etc) #34449

wants to merge 1 commit into from

Conversation

@regexident
Copy link
Contributor

An attempt at making the public types in syntax::ast a bit more approachable.

#rust-doc-days

@rust-highfive
Copy link
Contributor

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.

killercup
killercup reviewed Jun 24, 2016
View reviewed changes
src/libsyntax/ast.rs Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

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?

@regexident
Copy link
Contributor Author

Thanks for your comments, @killercup!
Much appreciated! 👍

GuillaumeGomez
GuillaumeGomez reviewed Jun 24, 2016
View reviewed changes
src/libsyntax/ast.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

The whitespace before "ignore" is useless.

@GuillaumeGomez
Copy link
Member

👍

@steveklabnik
Copy link
Contributor

@bors: r+ rollup

@bors
Copy link
Collaborator

bors commented Jun 24, 2016

📌 Commit 32ef890 has been approved by steveklabnik

@Manishearth Manishearth mentioned this pull request Jun 25, 2016
Merged
@regexident regexident closed this Jun 25, 2016
@regexident regexident deleted the ast_docs branch June 25, 2016 12:06
Manishearth added a commit to Manishearth/rust that referenced this pull request Jun 25, 2016
@Manishearth
Rollup merge of rust-lang#34449 - regexident:ast_docs, r=steveklabnik
77b6a64 
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/)
bors added a commit that referenced this pull request Jun 25, 2016
@bors
Auto merge of #34464 - Manishearth:rollup, r=Manishearth
b8214dc 
Rollup of 8 pull requests

- Successful merges: #34379, #34406, #34411, #34414, #34435, #34438, #34445, #34449
- Failed merges:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@pnkfelix pnkfelix

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@regexident @rust-highfive @GuillaumeGomez @steveklabnik @bors @killercup @pnkfelix