-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Improve Debug documentation #25830
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 Debug documentation #25830
Conversation
r? @pcwalton (rust_highfive has picked a reviewer for you, use r? to override) |
@@ -269,6 +269,22 @@ impl<'a> Display for Arguments<'a> { | |||
|
|||
/// Format trait for the `:?` format. Useful for debugging, all types | |||
/// should implement this. | |||
/// | |||
/// Generally speaking, you should just `derive` a `Debug` implementation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably worth mentioning the debug builder methods for use by manual implementations (Formatter::debug_<foo>
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have never used these before. Will investigate.
I agree with @sfackler that a mention of the debug builders would be good here as well! |
updated! |
/// ``` | ||
/// | ||
/// There are a number of `debug_*` methods on `Formatter` to help you with manual | ||
/// implemnetations, such as [`debug_struct`][debug_struct]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
implemnetations
r=me with a minor typo, thanks! |
@bors: r=alexcrichton rollup |
📌 Commit 8bfc027 has been approved by |
⌛ Testing commit 8bfc027 with merge 115b327... |
💔 Test failed - auto-mac-64-opt |
Sigh. Confirmed that tests pass now. |
@bors: r=alexcrichton rollup |
📌 Commit 977d40f has been approved by |
⌛ Testing commit 977d40f with merge 915dc2c... |
💔 Test failed - auto-linux-64-opt |
@bors: retry On Thu, May 28, 2015 at 10:34 PM, bors [email protected] wrote:
|
⌛ Testing commit 977d40f with merge b9eb606... |
No description provided.