Rewrite documentation comment for right movement (#32547)

I don't think the documentation comment is saying the right thing. This
version is more similar to the comment of the left movement function.

Release Notes:

- N/A
This commit is contained in:
fantacell 2025-06-12 07:39:17 +02:00 committed by GitHub
parent 242af863f5
commit 1a321b51df
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -58,8 +58,8 @@ pub fn saturating_left(map: &DisplaySnapshot, mut point: DisplayPoint) -> Displa
map.clip_point(point, Bias::Left) map.clip_point(point, Bias::Left)
} }
/// Returns a column to the right of the current point, doing nothing /// Returns a column to the right of the current point, wrapping
// if that point is at the end of the line. /// to the next line if that point is at the end of line.
pub fn right(map: &DisplaySnapshot, mut point: DisplayPoint) -> DisplayPoint { pub fn right(map: &DisplaySnapshot, mut point: DisplayPoint) -> DisplayPoint {
if point.column() < map.line_len(point.row()) { if point.column() < map.line_len(point.row()) {
*point.column_mut() += 1; *point.column_mut() += 1;