Correct docs for TouchpadRotate event

rust-windowing · Aug 16, 2022 · 0c37d9d · 0c37d9d
1 parent 1553dbf
commit 0c37d9d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/examples/touchpad_gestures.rs b/examples/touchpad_gestures.rs
@@ -31,9 +31,9 @@ fn main() {
                 }
                 WindowEvent::TouchpadRotate { delta, .. } => {
                     if delta > 0.0 {
-                        println!("Rotated left {}", delta);
+                        println!("Rotated counterclockwise {}", delta);
                     } else {
-                        println!("Rotated right {}", delta);
+                        println!("Rotated clockwise {}", delta);
                     }
                 }
                 _ => (),

diff --git a/src/event.rs b/src/event.rs
@@ -331,10 +331,12 @@ pub enum WindowEvent<'a> {
 
     /// Touchpad rotation event with two-finger rotation gesture.
     ///
-    /// Positive delta values indicate rotation to left (counterclockwise) and
-    /// negative delta values indicate rotation to right (clockwise).
+    /// Positive delta values indicate rotation counterclockwise and
+    /// negative delta values indicate rotation clockwise.
     ///
-    /// At the moment, only supported on macOS.
+    /// ## Platform-specific
+    /// 
+    /// - Only available on **macOS**.
     TouchpadRotate {
         device_id: DeviceId,
         delta: f32,