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.

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

A few documentation improvements for syntax::print::pp #39557

Merged
merged 1 commit into from
Feb 8, 2017
Merged

A few documentation improvements for syntax::print::pp #39557

merged 1 commit into from
Feb 8, 2017

Conversation

bjorn3
Copy link
Member

@bjorn3 bjorn3 commented Feb 5, 2017

  • Moved algorithm explanation to module docs
  • Added ``` before and after the examples
  • Explanation of the rbox, ibox and cbox names
  • Added docs about the breaking types to Breaks

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @nrc (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.

@bjorn3
Copy link
Member Author

bjorn3 commented Feb 5, 2017

r? @jseyfried

@rust-highfive rust-highfive assigned jseyfried and unassigned nrc Feb 5, 2017
@bjorn3 bjorn3 mentioned this pull request Feb 5, 2017
Closed
jseyfried
jseyfried reviewed Feb 6, 2017
View reviewed changes
src/libsyntax/print/pp.rs Outdated
/// foo(hello,
/// there
/// good,
/// friends);
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks like a duplicate of the comment starting here. I would just give a one line summary here and say it's described in more detail in the module docs.

jseyfried
jseyfried approved these changes Feb 6, 2017
View reviewed changes
Copy link
Contributor

@jseyfried jseyfried left a comment

Choose a reason for hiding this comment

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

r=me with commits squahsed

@bjorn3
A few documentation improvements for syntax::print::pp
1ee88e5 
* Moved algorithm explanation to module docs
* Added ``` before and after the examples
* Explanation of the `rbox`, `ibox` and `cbox` names
* Added docs about the breaking types to `Breaks`
@bjorn3
Copy link
Member Author

bjorn3 commented Feb 6, 2017

Squashed

@steveklabnik
Copy link
Member

@bors: r=jseyfried

@bors
Copy link
Contributor

bors commented Feb 6, 2017

📌 Commit 1ee88e5 has been approved by jseyfried

@frewsxcv frewsxcv mentioned this pull request Feb 7, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 7, 2017
@frewsxcv
Rollup merge of rust-lang#39557 - bjorn3:pp-docs, r=jseyfried
d73b264 
A few documentation improvements for `syntax::print::pp`

* Moved algorithm explanation to module docs
* Added ``` before and after the examples
* Explanation of the `rbox`, `ibox` and `cbox` names
* Added docs about the breaking types to `Breaks`
@frewsxcv frewsxcv mentioned this pull request Feb 7, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 7, 2017
@frewsxcv
Rollup merge of rust-lang#39557 - bjorn3:pp-docs, r=jseyfried
cf7fbb7 
A few documentation improvements for `syntax::print::pp`

* Moved algorithm explanation to module docs
* Added ``` before and after the examples
* Explanation of the `rbox`, `ibox` and `cbox` names
* Added docs about the breaking types to `Breaks`
@frewsxcv frewsxcv mentioned this pull request Feb 7, 2017
Closed
bors added a commit that referenced this pull request Feb 7, 2017
@bors
Auto merge of #39613 - frewsxcv:rollup, r=frewsxcv
a4fb614 
Rollup of 15 pull requests

- Successful merges: #38764, #39361, #39426, #39462, #39482, #39557, #39561, #39582, #39583, #39587, #39598, #39599, #39601, #39602, #39604
- Failed merges:
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 8, 2017
@frewsxcv
Rollup merge of rust-lang#39557 - bjorn3:pp-docs, r=jseyfried
4215d3e 
A few documentation improvements for `syntax::print::pp`

* Moved algorithm explanation to module docs
* Added ``` before and after the examples
* Explanation of the `rbox`, `ibox` and `cbox` names
* Added docs about the breaking types to `Breaks`
@frewsxcv frewsxcv mentioned this pull request Feb 8, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 8, 2017
@frewsxcv
Rollup merge of rust-lang#39557 - bjorn3:pp-docs, r=jseyfried
3ee6fae 
A few documentation improvements for `syntax::print::pp`

* Moved algorithm explanation to module docs
* Added ``` before and after the examples
* Explanation of the `rbox`, `ibox` and `cbox` names
* Added docs about the breaking types to `Breaks`
@frewsxcv frewsxcv mentioned this pull request Feb 8, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 8, 2017
@frewsxcv
Rollup merge of rust-lang#39557 - bjorn3:pp-docs, r=jseyfried
75f97db 
A few documentation improvements for `syntax::print::pp`

* Moved algorithm explanation to module docs
* Added ``` before and after the examples
* Explanation of the `rbox`, `ibox` and `cbox` names
* Added docs about the breaking types to `Breaks`
@frewsxcv frewsxcv mentioned this pull request Feb 8, 2017
Merged
bors added a commit that referenced this pull request Feb 8, 2017
@bors
Auto merge of #39645 - frewsxcv:rollup, r=frewsxcv
4379e2f 
Rollup of 11 pull requests

- Successful merges: #39462, #39512, #39529, #39557, #39561, #39582, #39583, #39597, #39622, #39624, #39630
- Failed merges:
@bors bors merged commit 1ee88e5 into rust-lang:master Feb 8, 2017
@bjorn3 bjorn3 deleted the pp-docs branch February 9, 2017 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jseyfried jseyfried jseyfried approved these changes

Assignees

@jseyfried jseyfried

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@bjorn3 @rust-highfive @steveklabnik @bors @jseyfried @nrc