[v1] rust: correct documentation comment for rbtree cursor peek_next method

[PATCH] rust: correct documentation comment for rbtree cursor peek_next method

Posted by Hang Shu 1 month, 1 week ago

From: Hang Shu <hangshu847@gmail.com>

The peek_next method's doc comment incorrectly stated it accesses the
"previous" node when it actually accesses the next node. This commit
fixes the documentation to accurately reflect the method's behavior.

Signed-off-by: Hang Shu <hangshu847@gmail.com>
---
 rust/kernel/rbtree.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/kernel/rbtree.rs b/rust/kernel/rbtree.rs
index b8fe6be6f..9e178dacd 100644
--- a/rust/kernel/rbtree.rs
+++ b/rust/kernel/rbtree.rs
@@ -835,7 +835,7 @@ pub fn peek_prev(&self) -> Option<(&K, &V)> {
         self.peek(Direction::Prev)
     }
 
-    /// Access the previous node without moving the cursor.
+    /// Access the next node without moving the cursor.
     pub fn peek_next(&self) -> Option<(&K, &V)> {
         self.peek(Direction::Next)
     }
-- 
2.43.0

Re: [PATCH] rust: correct documentation comment for rbtree cursor peek_next method

Posted by Alice Ryhl 1 month, 1 week ago

On Thu, Nov 06, 2025 at 11:20:14AM +0000, Hang Shu wrote:
> From: Hang Shu <hangshu847@gmail.com>
> 
> The peek_next method's doc comment incorrectly stated it accesses the
> "previous" node when it actually accesses the next node. This commit
> fixes the documentation to accurately reflect the method's behavior.
> 
> Signed-off-by: Hang Shu <hangshu847@gmail.com>

Thanks.

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

This should probably have a fixes tag:

Fixes: 98c14e40e07a ("rust: rbtree: add cursor")

Alice