-
Notifications
You must be signed in to change notification settings - Fork 13.2k
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
Add missing documentation examples for BinaryHeap. #32137
Add missing documentation examples for BinaryHeap. #32137
Conversation
As part of the ongoing effort to document all methods with examples, this commit adds the missing examples for the `BinaryHeap` collection type. This is part of issue rust-lang#29348.
@@ -331,6 +374,17 @@ impl<T: Ord> BinaryHeap<T> { | |||
} | |||
|
|||
/// Discards as much additional capacity as possible. | |||
/// | |||
/// # Examples | |||
/// |
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.
same comment about basic usage from the other PR here
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.
Fixed!
@bors: r+ rollup Thanks so much! |
📌 Commit 04436fb has been approved by |
…heap, r=steveklabnik Add missing documentation examples for BinaryHeap. As part of the ongoing effort to document all methods with examples, this commit adds the missing examples for the `BinaryHeap` collection type. This is part of issue rust-lang#29348. r? @steveklabnik
@bors: r- the travis failure here is legit, there's an extra |
@steveklabnik Fixed! On a related note, what is your workflow for running these tests quickly and easily as you make doc changes? Now that I'm trying to get more involved and doing more, I'd really like to understand a bit more about how you work on a day-to-day basis, especially so I can avoid silly mistakes like this! 😀 |
I usually do So in this case, |
@steveklabnik Ah that's awesome, thanks heaps for your help and patience! PR is ready for you and tests are green again. I'll now keep ^^ these tests running on a watch as I get through the other tasks from #29348. |
@bors: r+ rollup Great! :) Also, there's a #rust-docs on IRC if you want to chat in realtime about issues relating to docs. |
📌 Commit da4fda4 has been approved by |
…heap, r=steveklabnik Add missing documentation examples for BinaryHeap. As part of the ongoing effort to document all methods with examples, this commit adds the missing examples for the `BinaryHeap` collection type. This is part of issue rust-lang#29348. r? @steveklabnik
…heap, r=steveklabnik Add missing documentation examples for BinaryHeap. As part of the ongoing effort to document all methods with examples, this commit adds the missing examples for the `BinaryHeap` collection type. This is part of issue rust-lang#29348. r? @steveklabnik
As part of the ongoing effort to document all methods with examples,
this commit adds the missing examples for the
BinaryHeap
collectiontype.
This is part of issue #29348.
r? @steveklabnik