diff options
| author | est31 <MTest31@outlook.com> | 2021-09-16 13:35:54 +0200 |
|---|---|---|
| committer | est31 <MTest31@outlook.com> | 2021-09-16 13:35:54 +0200 |
| commit | a8a829deb491db3b87bbe715eece7a7dd5cd288c (patch) | |
| tree | 5bb4e80470368b366970a0783ea9036f7437b358 /library/alloc/src/collections | |
| parent | 52ab3e8e76afde6c6b5059816f641e49ef008c30 (diff) | |
| download | rust-a8a829deb491db3b87bbe715eece7a7dd5cd288c.tar.gz rust-a8a829deb491db3b87bbe715eece7a7dd5cd288c.zip | |
Add intra-doc-links to BinaryHeap rustdoc
Diffstat (limited to 'library/alloc/src/collections')
| -rw-r--r-- | library/alloc/src/collections/binary_heap.rs | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/library/alloc/src/collections/binary_heap.rs b/library/alloc/src/collections/binary_heap.rs index 28e4f8bba05..ca289502379 100644 --- a/library/alloc/src/collections/binary_heap.rs +++ b/library/alloc/src/collections/binary_heap.rs @@ -159,9 +159,9 @@ use super::SpecExtend; /// This will be a max-heap. /// /// It is a logic error for an item to be modified in such a way that the -/// item's ordering relative to any other item, as determined by the `Ord` +/// item's ordering relative to any other item, as determined by the [`Ord`] /// trait, changes while it is in the heap. This is normally only possible -/// through `Cell`, `RefCell`, global state, I/O, or unsafe code. The +/// through [`Cell`], [`RefCell`], global state, I/O, or unsafe code. The /// behavior resulting from such a logic error is not specified, but will /// not result in undefined behavior. This could include panics, incorrect /// results, aborts, memory leaks, and non-termination. @@ -219,7 +219,7 @@ use super::SpecExtend; /// /// ## Min-heap /// -/// Either `std::cmp::Reverse` or a custom `Ord` implementation can be used to +/// Either [`core::cmp::Reverse`] or a custom [`Ord`] implementation can be used to /// make `BinaryHeap` a min-heap. This makes `heap.pop()` return the smallest /// value instead of the greatest one. /// @@ -250,6 +250,10 @@ use super::SpecExtend; /// The value for `push` is an expected cost; the method documentation gives a /// more detailed analysis. /// +/// [`core::cmp::Reverse`]: core::cmp::Reverse +/// [`Ord`]: core::cmp::Ord +/// [`Cell`]: core::cell::Cell +/// [`RefCell`]: core::cell::RefCell /// [push]: BinaryHeap::push /// [pop]: BinaryHeap::pop /// [peek]: BinaryHeap::peek |
