summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Mendler <mail@daniel-mendler.de>2022-11-24 15:16:34 +0100
committerDaniel Mendler <mail@daniel-mendler.de>2022-11-24 15:16:34 +0100
commitefd5e31a7ec45ab537626a79809bb9ad4b39703d (patch)
tree79152a7d9f3f5602f6a8ed0d62152d9deba9c25a
parent86f2bc6692e59a73acd227363adaa0bca8b1e4d0 (diff)
Fix docstring warings (Fix #260)
-rw-r--r--extensions/corfu-popupinfo.el16
1 files changed, 6 insertions, 10 deletions
diff --git a/extensions/corfu-popupinfo.el b/extensions/corfu-popupinfo.el
index 79dda00..793f6a8 100644
--- a/extensions/corfu-popupinfo.el
+++ b/extensions/corfu-popupinfo.el
@@ -257,7 +257,7 @@ in the form of (X Y WIDTH HEIGHT)."
The WIDTH and HEIGHT of the info popup are in pixels.
The calculated area is in the form (X Y WIDTH HEIGHT DIR).
DIR indicates the horizontal position direction of the info popup
-relative to the candidate popup, its value can be 'right or 'left."
+relative to the candidate popup, its value can be right or left."
(pcase-let* ((border (alist-get 'child-frame-border-width corfu--frame-parameters))
(`(,_pfx ,_pfy ,pfw ,_pfh)
(corfu-popupinfo--frame-geometry (frame-parent corfu--frame)))
@@ -281,7 +281,7 @@ relative to the candidate popup, its value can be 'right or 'left."
The WIDTH and HEIGHT of the info popup are in pixels.
-The calculated area is in the form (X Y WIDTH HEIGHT 'vertical)."
+The calculated area is in the form (X Y WIDTH HEIGHT DIR)."
(pcase-let* ((border (alist-get 'child-frame-border-width corfu--frame-parameters))
(lh (default-line-height))
(`(,_pfx ,_pfy ,pfw ,pfh)
@@ -306,14 +306,10 @@ The calculated area is in the form (X Y WIDTH HEIGHT 'vertical)."
"Calculate the display area for the info popup.
If DIR is non-nil, the display area in the corresponding
-direction is calculated first, its value can be 'vertical, 'right
-or 'left.
-
-The pixel size of the info popup can be specified by WIDTH and HEIGHT.
-
-The calculated area is in the form (X Y WIDTH HEIGHT DIR).
-DIR indicates the position direction of the info popup relative to
-the candidate popup, its value is 'vertical, 'right or 'left."
+direction is calculated first, its value can be vertical, right
+or left. The pixel size of the info popup can be specified by
+WIDTH and HEIGHT. The calculated area is in the form (X Y WIDTH
+HEIGHT DIR)."
(unless (and width height)
(let ((size (corfu-popupinfo--size)))
(setq width (car size)