From 75dfaff33891d0505e3018a8357fa0619ef1fcc2 Mon Sep 17 00:00:00 2001
From: Pascal Sommer
Date: Wed, 11 Jan 2023 03:11:43 +0100
Subject: Add some function documentations (#5360)

---
 helix-view/src/editor.rs | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'helix-view/src')

diff --git a/helix-view/src/editor.rs b/helix-view/src/editor.rs
index 3521077e..547a4ffb 100644
--- a/helix-view/src/editor.rs
+++ b/helix-view/src/editor.rs
@@ -1341,6 +1341,8 @@ impl Editor {
             .find(|doc| doc.path().map(|p| p == path.as_ref()).unwrap_or(false))
     }
 
+    /// Gets the primary cursor position in screen coordinates,
+    /// or `None` if the primary cursor is not visible on screen.
     pub fn cursor(&self) -> (Option<Position>, CursorKind) {
         let config = self.config();
         let (view, doc) = current_ref!(self);
-- 
cgit v1.2.3-70-g09d2