Re: [PATCH] docs: rust: rbtree: fix incorrect description for `peek_next`

[Gary Guo]

On Fri, 12 Dec 2025 17:31:10 +0800
WeiKang Guo <guoweikang.kernel@xxxxxxxxxxx> wrote:

> The documentation for `Cursor::peek_next` incorrectly describes it as
> "Access the previous node without moving the cursor" when it actually
> accesses the next node. Update the description to correctly state
> "Access the next node without moving the cursor" to match the function
> name and implementation.
> 
> Reported-by: Miguel Ojeda <ojeda@xxxxxxxxxx>
> Closes: https://github.com/Rust-for-Linux/linux/issues/1205
> Fixes: 98c14e40e07a0 ("rust: rbtree: add cursor")
> Cc: stable@xxxxxxxxxxxxxxx
> Signed-off-by: WeiKang Guo <guoweikang.kernel@xxxxxxxxxxx>

Reviewed-by: Gary Guo <gary@xxxxxxxxxxx>

> ---
>  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 4729eb56827a..cd187e2ca328 100644
> --- a/rust/kernel/rbtree.rs
> +++ b/rust/kernel/rbtree.rs
> @@ -985,7 +985,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)
>      }