Skip to content

Improve the dbg! macro docs - #59528

Closed
DevQps wants to merge 6 commits into
rust-lang:masterfrom
DevQps:improve-dbg-macro-docs
Closed

Improve the dbg! macro docs #59528
DevQps wants to merge 6 commits into
rust-lang:masterfrom
DevQps:improve-dbg-macro-docs

Conversation

@DevQps

@DevQpsDevQps commented Mar 29, 2019

Copy link
Copy Markdown
Contributor

Description

As stated has been discussed in #58383 the docs do not clearly state why it is useful to have the option to use dbg! in release builds as well. This PR should change that.

closes#58383

@rust-highfive

rust-highfive commented Mar 29, 2019

Copy link
Copy Markdown
Contributor

r? @shepmaster

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 29, 2019
Centril
Centril reviewed Mar 29, 2019
View reviewed changes
Comment threadsrc/libstd/macros.rs Outdated
@Centril

Centril commented Mar 29, 2019

Copy link
Copy Markdown
Contributor

r? @Centril

Centril
Centril reviewed Mar 29, 2019
View reviewed changes
Comment threadsrc/libstd/macros.rs Outdated
Comment threadsrc/libstd/macros.rs Outdated
Centriland others added 2 commits March 29, 2019 16:24
@Centril@DevQps
Update src/libstd/macros.rs
fe210d0
Wrapped lines earlier such that it is more coherent with the rest of the text.
Co-Authored-By: DevQps <46896178+DevQps@users.noreply.github.com>
@Centril@DevQps
Update src/libstd/macros.rs
8705de4
Removed duplicate line.
Co-Authored-By: DevQps <46896178+DevQps@users.noreply.github.com>
@DevQps

DevQps commented Mar 29, 2019

Copy link
Copy Markdown
ContributorAuthor

@Centril Thanks for the suggestions. I wasn't aware that the text was written up to a specific length (makes sense now I look at it). I committed your changes!

@Centril

Centril commented Mar 29, 2019

Copy link
Copy Markdown
Contributor

Thanks! @bors r+ rollup

@bors

bors commented Mar 29, 2019

Copy link
Copy Markdown
Collaborator

📌 Commit 8705de4 has been approved by Centril

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 29, 2019
tesuji
tesuji reviewed Mar 29, 2019
View reviewed changes
Comment threadsrc/libstd/macros.rs Outdated
tesuji
tesuji reviewed Mar 29, 2019
View reviewed changes
Comment threadsrc/libstd/macros.rs Outdated
Centril added a commit to Centril/rust that referenced this pull request Mar 29, 2019
@Centril
Rollup merge ofrust-lang#59528- DevQps:improve-dbg-macro-docs, r=Ce…
abd3db9
…ntril
Improve the dbg! macro docs
# Description
As stated has been discussed in rust-lang#58383 the docs do not clearly state why it is useful to have the option to use `dbg!` in release builds as well. This PR should change that.
closesrust-lang#58383
@CentrilCentril mentioned this pull request Mar 29, 2019
Closed
Centril added a commit to Centril/rust that referenced this pull request Mar 30, 2019
@Centril
Rollup merge ofrust-lang#59528- DevQps:improve-dbg-macro-docs, r=Ce…
183afcd
…ntril
Improve the dbg! macro docs
# Description
As stated has been discussed in rust-lang#58383 the docs do not clearly state why it is useful to have the option to use `dbg!` in release builds as well. This PR should change that.
closesrust-lang#58383
@CentrilCentril mentioned this pull request Mar 30, 2019
Merged
bors added a commit that referenced this pull request Mar 30, 2019
@bors
Auto merge of#59550- Centril:rollup, r=Centril
6c49da4
Rollup of 10 pull requests
Successful merges:
- #59376 (RFC 2008: Enum Variants)
- #59453 (Recover from parse error in tuple syntax)
- #59455 (Account for short-hand field syntax when suggesting borrow)
- #59499 (Fix broken download link in the armhf-gnu image)
- #59512 (implement `AsRawFd` for stdio locks)
- #59525 (Whitelist some rustc attrs)
- #59528 (Improve the dbg! macro docs )
- #59532 (In doc examples, don't ignore read/write results)
- #59534 (rustdoc: collapse blanket impls in the same way as normal impls)
- #59537 (Fix OnceWith docstring.)
Failed merges:
r? @ghost
@Centril

Centril commented Mar 30, 2019

Copy link
Copy Markdown
Contributor

@DevQps Please cherry-pick 4c5ef86 onto a new PR instead. Also, we prefer not to have merge commits in our history.

@DevQps

DevQps commented Mar 30, 2019•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

@Centril I am just trying to learn here a bit, so I hope you don't mind this question: But I seems that by doing the roll-up commit, you pushed the changes into master? Does that mean this branch can be closed now? I did some changes that @lzutao did as well, not sure if they were taken with the roll-up as well? Or am I just misunderstanding the whole roll-up part? :)

EDIT: I just read your other comment :) I'll try my best :)

@Centril

Centril commented Mar 30, 2019

Copy link
Copy Markdown
Contributor

#59550 hasn't been merged yet; but when it will, ordinarily this PR would also be merged. However, since you added commits it won't be automatically closed by GH. Instead, once the rollup is merged, close this PR manually and you can make a new PR with the other changes if you like.

@DevQpsDevQps mentioned this pull request Mar 30, 2019
Closed
@DevQps

DevQps commented Mar 30, 2019

Copy link
Copy Markdown
ContributorAuthor

@Centril Alright thanks! I will close the other one I opened in meanwhile then, and just wait for this to finish and then add a new one! Thanks for all the support, stuff is a bit new here, so it takes me some time understand the complete process :)

@Centril

Centril commented Mar 30, 2019

Copy link
Copy Markdown
Contributor

#59550 was merged.

@CentrilCentril closed this Mar 30, 2019
@DevQpsDevQps mentioned this pull request Mar 30, 2019
Merged
Centril added a commit to Centril/rust that referenced this pull request Mar 30, 2019
@Centril
Rollup merge ofrust-lang#59562- DevQps:dbg-macro-docs, r=Centril
07f8203
Changed reference style in dbg macro docs.
# Description
A continuation of Pull Request rust-lang#59528 :
- Fixed method of referencing and adjusted the references as suggested by @lzutao
Centril added a commit to Centril/rust that referenced this pull request Mar 30, 2019
@Centril
Rollup merge ofrust-lang#59562- DevQps:dbg-macro-docs, r=Centril
50dc303
Changed reference style in dbg macro docs.
# Description
A continuation of Pull Request rust-lang#59528 :
- Fixed method of referencing and adjusted the references as suggested by @lzutao
Centril added a commit to Centril/rust that referenced this pull request Mar 30, 2019
@Centril
Rollup merge ofrust-lang#59562- DevQps:dbg-macro-docs, r=Centril
c6f0ad1
Changed reference style in dbg macro docs.
# Description
A continuation of Pull Request rust-lang#59528 :
- Fixed method of referencing and adjusted the references as suggested by @lzutao
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

3 more reviewers
@steveklabniksteveklabniksteveklabnik left review comments
@CentrilCentrilCentril left review comments
@tesujitesujitesuji left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@CentrilCentril

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Suppress dbg! in release build

7 participants

@DevQps@rust-highfive@Centril@bors@steveklabnik@tesuji@shepmaster