[nongnu] elpa/telephone-line fb62b73c9f 164/195: Add docstring for HUD axis func

[ELPA Syncer]

branch: elpa/telephone-line
commit fb62b73c9fd582d826aba37b9c275acd3b364191
Author: Daniel Bordak <dbordak@fastmail.fm>
Commit: Daniel Bordak <dbordak@fastmail.fm>

    Add docstring for HUD axis func
---
 telephone-line-segments.el | 1 +
 1 file changed, 1 insertion(+)

diff --git a/telephone-line-segments.el b/telephone-line-segments.el
index 068fac3c7a..759a752909 100644
--- a/telephone-line-segments.el
+++ b/telephone-line-segments.el
@@ -122,6 +122,7 @@ mouse-3: Toggle minor modes"
                  face ,face)))
 
 (defun telephone-line--hud-axis-func (y)
+  "Generate a HUD axis value given the current position Y."
   (let* ((height (or telephone-line-height (frame-char-height)))
          (start (floor (* height (float (window-start))) (point-max)))
          (end (ceiling (* height (float (window-end))) (point-max))))