Skip to content

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

Merged
bors merged 1 commit into
rust-lang:masterfrom
bjorn3:pp-docs
Feb 8, 2017
Merged

A few documentation improvements for syntax::print::pp#39557
bors merged 1 commit into
rust-lang:masterfrom
bjorn3:pp-docs

Conversation

@bjorn3

Copy link
Copy Markdown
Member
  • 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
Copy Markdown
Contributor

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
Copy Markdown
MemberAuthor

r? @jseyfried

@rust-highfiverust-highfive assigned jseyfried and unassigned nrcFeb 5, 2017
Comment threadsrc/libsyntax/print/pp.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 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.

@jseyfriedjseyfried left a comment

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.

r=me with commits squahsed

* 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
Copy Markdown
MemberAuthor

Squashed

@steveklabnik

Copy link
Copy Markdown
Contributor

@bors: r=jseyfried

@bors

bors commented Feb 6, 2017

Copy link
Copy Markdown
Collaborator

📌 Commit 1ee88e5 has been approved by jseyfried

@frewsxcvfrewsxcv mentioned this pull request Feb 7, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 7, 2017
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`
@frewsxcvfrewsxcv mentioned this pull request Feb 7, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 7, 2017
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`
@frewsxcvfrewsxcv mentioned this pull request Feb 7, 2017
bors added a commit that referenced this pull request Feb 7, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 8, 2017
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`
@frewsxcvfrewsxcv mentioned this pull request Feb 8, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 8, 2017
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`
@frewsxcvfrewsxcv mentioned this pull request Feb 8, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Feb 8, 2017
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`
@frewsxcvfrewsxcv mentioned this pull request Feb 8, 2017
bors added a commit that referenced this pull request Feb 8, 2017
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:masterFeb 8, 2017
@bjorn3
bjorn3 deleted the pp-docs branch February 9, 2017 05:38
Sign up for freeto 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.

6 participants

@bjorn3@rust-highfive@steveklabnik@bors@jseyfried@nrc