diff options
| author | Stein Somers <git@steinsomers.be> | 2021-01-25 10:04:09 +0100 |
|---|---|---|
| committer | Stein Somers <git@steinsomers.be> | 2021-02-09 13:19:37 +0100 |
| commit | f7edf5ce051e64c2d392e19819542e177867e714 (patch) | |
| tree | 147e5e36e417904844c3a9b0c57b393a4496d3c2 | |
| parent | f4008fe94935d05ffb3a48fc5b7149070bb45550 (diff) | |
| download | rust-f7edf5ce051e64c2d392e19819542e177867e714.tar.gz rust-f7edf5ce051e64c2d392e19819542e177867e714.zip | |
BTreeMap: fix internal comments
| -rw-r--r-- | library/alloc/src/collections/btree/navigate.rs | 7 | ||||
| -rw-r--r-- | library/alloc/src/collections/btree/node.rs | 2 |
2 files changed, 5 insertions, 4 deletions
diff --git a/library/alloc/src/collections/btree/navigate.rs b/library/alloc/src/collections/btree/navigate.rs index 1ef2a572ddd..259b22e5c66 100644 --- a/library/alloc/src/collections/btree/navigate.rs +++ b/library/alloc/src/collections/btree/navigate.rs @@ -103,7 +103,8 @@ where } } -/// Equivalent to `range_search(k, v, ..)` but without the `Ord` bound. +/// Equivalent to `range_search(root1, root2, ..)` but without the `Ord` bound. +/// Equivalent to `(root1.first_leaf_edge(), root2.last_leaf_edge())` but more efficient. fn full_range<BorrowType: marker::BorrowType, K, V>( root1: NodeRef<BorrowType, K, V, marker::LeafOrInternal>, root2: NodeRef<BorrowType, K, V, marker::LeafOrInternal>, @@ -130,7 +131,7 @@ fn full_range<BorrowType: marker::BorrowType, K, V>( } impl<'a, K: 'a, V: 'a> NodeRef<marker::Immut<'a>, K, V, marker::LeafOrInternal> { - /// Creates a pair of leaf edges delimiting a specified range in or underneath a node. + /// Finds the pair of leaf edges delimiting a specific range in a tree. /// /// The result is meaningful only if the tree is ordered by key, like the tree /// in a `BTreeMap` is. @@ -149,7 +150,7 @@ impl<'a, K: 'a, V: 'a> NodeRef<marker::Immut<'a>, K, V, marker::LeafOrInternal> range_search(self, self, range) } - /// Returns (self.first_leaf_edge(), self.last_leaf_edge()), but more efficiently. + /// Finds the pair of leaf edges delimiting an entire tree. pub fn full_range( self, ) -> ( diff --git a/library/alloc/src/collections/btree/node.rs b/library/alloc/src/collections/btree/node.rs index 1d632512c78..6f67aadc161 100644 --- a/library/alloc/src/collections/btree/node.rs +++ b/library/alloc/src/collections/btree/node.rs @@ -169,7 +169,7 @@ impl<K, V, Type> NodeRef<marker::Owned, K, V, Type> { NodeRef { height: self.height, node: self.node, _marker: PhantomData } } - /// Irreversibly transistions to a reference that offers traversal, + /// Irreversibly transitions to a reference that permits traversal and offers /// destructive methods and little else. pub fn into_dying(self) -> NodeRef<marker::Dying, K, V, Type> { NodeRef { height: self.height, node: self.node, _marker: PhantomData } |
