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.

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

Improve the dbg! macro docs #59528

Closed
wants to merge 6 commits into from

Conversation

DevQps
Copy link
Contributor

@DevQps DevQps commented Mar 29, 2019

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
Copy link
Collaborator

r? @shepmaster

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

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 29, 2019
src/libstd/macros.rs Outdated Show resolved Hide resolved
@Centril
Copy link
Contributor

Centril commented Mar 29, 2019

r? @Centril

@rust-highfive rust-highfive assigned Centril and unassigned shepmaster Mar 29, 2019
src/libstd/macros.rs Outdated Show resolved Hide resolved
src/libstd/macros.rs Outdated Show resolved Hide resolved
Centril and others added 2 commits March 29, 2019 16:24
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>
Removed duplicate line.

Co-Authored-By: DevQps <46896178+DevQps@users.noreply.github.com>
@DevQps
Copy link
Contributor Author

DevQps commented Mar 29, 2019

@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
Copy link
Contributor

Centril commented Mar 29, 2019

Thanks! @bors r+ rollup

@bors
Copy link
Contributor

bors commented Mar 29, 2019

📌 Commit 8705de4 has been approved by Centril

@bors bors 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
src/libstd/macros.rs Outdated Show resolved Hide resolved
src/libstd/macros.rs Outdated Show resolved Hide resolved
Centril added a commit to Centril/rust that referenced this pull request Mar 29, 2019
…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.

closes rust-lang#58383
Centril added a commit to Centril/rust that referenced this pull request Mar 30, 2019
…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.

closes rust-lang#58383
bors added a commit that referenced this pull request Mar 30, 2019
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
Copy link
Contributor

Centril commented Mar 30, 2019

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

@DevQps
Copy link
Contributor Author

DevQps commented Mar 30, 2019

@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
Copy link
Contributor

Centril commented Mar 30, 2019

#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.

@DevQps
Copy link
Contributor Author

DevQps commented Mar 30, 2019

@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
Copy link
Contributor

Centril commented Mar 30, 2019

#59550 was merged.

@Centril Centril closed this Mar 30, 2019
Centril added a commit to Centril/rust that referenced this pull request Mar 30, 2019
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
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
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 free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Suppress dbg! in release build
7 participants