Skip to content

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

Merged
merged 1 commit into from
May 29, 2015
Merged

Improve Debug documentation #25830

merged 1 commit into from
May 29, 2015

Conversation

steveklabnik
Copy link
Member

No description provided.

@rust-highfive
Copy link
Contributor

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.
Copy link
Member

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>)

Copy link
Member Author

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.

@alexcrichton
Copy link
Member

I agree with @sfackler that a mention of the debug builders would be good here as well!

@steveklabnik
Copy link
Member Author

updated!

/// ```
///
/// There are a number of `debug_*` methods on `Formatter` to help you with manual
/// implemnetations, such as [`debug_struct`][debug_struct].
Copy link
Member

Choose a reason for hiding this comment

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

implemnetations

@alexcrichton
Copy link
Member

r=me with a minor typo, thanks!

@steveklabnik
Copy link
Member Author

@bors: r=alexcrichton rollup

@bors
Copy link
Collaborator

bors commented May 27, 2015

📌 Commit 8bfc027 has been approved by alexcrichton

@bors
Copy link
Collaborator

bors commented May 28, 2015

⌛ Testing commit 8bfc027 with merge 115b327...

@bors
Copy link
Collaborator

bors commented May 28, 2015

💔 Test failed - auto-mac-64-opt

@steveklabnik
Copy link
Member Author

Sigh. Confirmed that tests pass now.

@steveklabnik
Copy link
Member Author

@bors: r=alexcrichton rollup

@bors
Copy link
Collaborator

bors commented May 28, 2015

📌 Commit 977d40f has been approved by alexcrichton

steveklabnik added a commit to steveklabnik/rust that referenced this pull request May 29, 2015
steveklabnik added a commit to steveklabnik/rust that referenced this pull request May 29, 2015
@bors
Copy link
Collaborator

bors commented May 29, 2015

⌛ Testing commit 977d40f with merge 915dc2c...

@bors
Copy link
Collaborator

bors commented May 29, 2015

💔 Test failed - auto-linux-64-opt

@alexcrichton
Copy link
Member

@bors: retry

On Thu, May 28, 2015 at 10:34 PM, bors [email protected] wrote:

[image: 💔] Test failed - auto-linux-64-opt
http://buildbot.rust-lang.org/builders/auto-linux-64-opt/builds/5135


Reply to this email directly or view it on GitHub
#25830 (comment).

@bors
Copy link
Collaborator

bors commented May 29, 2015

⌛ Testing commit 977d40f with merge b9eb606...

@bors bors merged commit 977d40f into rust-lang:master May 29, 2015
Sign up for free to 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