Skip to content

Commit e087178

Browse files
committed
; Fix more checkdoc warnings in which-key.el
* lisp/which-key.el (which-key-special-keys) (which-key-highlighted-command-face, which-key--safe-lookup-key) (which-key--safe-lookup-key-description) (which-key-add-keymap-based-replacements) (which-key-add-key-based-replacements) (which-key--fit-buffer-to-window-horizontally) (which-key--popup-max-dimensions) (which-key--propertize-description, which-key--format-and-replace) (which-key--get-bindings, which-key--list-to-pages) (which-key--create-pages-1, which-key--create-pages) (which-key--get-popup-map, which-key-show-major-mode): Fix checkdoc warnings.
1 parent 43a2240 commit e087178

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

lisp/which-key.el

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -238,8 +238,8 @@ face to apply)."
238238

239239
(defcustom which-key-special-keys '()
240240
"These keys will automatically be truncated to one character.
241-
They also have `which-key-special-key-face' applied to them. This
242-
is disabled by default. An example configuration is
241+
They also have `which-key-special-key-face' applied to them. This
242+
is disabled by default. An example configuration is
243243
244244
\(setq which-key-special-keys \\='(\"SPC\" \"TAB\" \"RET\" \"ESC\" \"DEL\")\)"
245245
:type '(repeat string)
@@ -596,8 +596,9 @@ it."
596596

597597
(defface which-key-highlighted-command-face
598598
'((t . (:inherit which-key-command-description-face :underline t)))
599-
"Default face for the command description when it is a command
600-
and it matches a string in `which-key-highlighted-command-list'."
599+
"Default face for command description.
600+
To be highlighted, it must be a command and match a string in
601+
`which-key-highlighted-command-list'."
601602
:group 'which-key-faces
602603
:package-version "1.0" :version "30.1")
603604

@@ -762,17 +763,17 @@ Used when `which-key-popup-type' is frame.")
762763

763764
(defsubst which-key--safe-lookup-key (keymap key)
764765
"Version of `lookup-key' that allows KEYMAP to be nil.
765-
Also convert numeric results of `lookup-key' to nil. KEY is not
766-
checked."
766+
Also convert numeric results of `lookup-key' to nil.
767+
KEY is not checked."
767768
(when (keymapp keymap)
768769
(let ((result (lookup-key keymap key)))
769770
(when (and result (not (numberp result)))
770771
result))))
771772

772773
(defsubst which-key--safe-lookup-key-description (keymap key)
773774
"Version of `lookup-key' that allows KEYMAP to be nil.
774-
Also convert numeric results of `lookup-key' to nil. KEY
775-
should be formatted as an input for `kbd'."
775+
Also convert numeric results of `lookup-key' to nil.
776+
KEY should be formatted as an input for `kbd'."
776777
(let ((key (ignore-errors (kbd key))))
777778
(when (and key (keymapp keymap))
778779
(let ((result (lookup-key keymap key)))
@@ -1006,12 +1007,12 @@ but more functional."
10061007
;;;###autoload
10071008
(defun which-key-add-keymap-based-replacements (keymap key replacement &rest more)
10081009
"Replace the description of KEY using REPLACEMENT in KEYMAP.
1009-
KEY should take a format suitable for use in `kbd'. REPLACEMENT
1010+
KEY should take a format suitable for use in `kbd'. REPLACEMENT
10101011
should be a cons cell of the form \(STRING . COMMAND\) for each
10111012
REPLACEMENT, where STRING is the replacement string and COMMAND
10121013
is a symbol corresponding to the intended command to be
1013-
replaced. COMMAND can be nil if the binding corresponds to a key
1014-
prefix. An example is
1014+
replaced. COMMAND can be nil if the binding corresponds to a key
1015+
prefix. An example is
10151016
10161017
\(which-key-add-keymap-based-replacements global-map
10171018
\"C-x w\" \\='\(\"Save as\" . write-file\)\).
@@ -1038,8 +1039,8 @@ for REPLACEMENT will eventually be removed."
10381039
(defun which-key-add-key-based-replacements
10391040
(key-sequence replacement &rest more)
10401041
"Replace the description of KEY-SEQUENCE with REPLACEMENT.
1041-
KEY-SEQUENCE is a string suitable for use in `kbd'. REPLACEMENT
1042-
may either be a string, as in
1042+
KEY-SEQUENCE is a string suitable for use in `kbd'.
1043+
REPLACEMENT may either be a string, as in
10431044
10441045
\(which-key-add-key-based-replacements \"C-x 1\" \"maximize\"\)
10451046
@@ -1260,7 +1261,7 @@ is shown, or if there is no need to start the closing timer."
12601261
(&optional window &rest params)
12611262
"Slightly modified version of `fit-buffer-to-window'.
12621263
Use &rest params because `fit-buffer-to-window' has a different
1263-
call signature in different emacs versions"
1264+
call signature in different Emacs versions"
12641265
(let ((fit-window-to-buffer-horizontally t)
12651266
(window-min-height 1))
12661267
(apply #'fit-window-to-buffer window params)))
@@ -1364,7 +1365,7 @@ Display window alist: %s"
13641365
(defun which-key--popup-max-dimensions ()
13651366
"Return maximum dimension available for popup.
13661367
Dimension functions should return the maximum possible (height
1367-
. width) of the intended popup. SELECTED-WINDOW-WIDTH is the
1368+
. width) of the intended popup. SELECTED-WINDOW-WIDTH is the
13681369
width of currently active window, not the which-key buffer
13691370
window."
13701371
(cl-ecase which-key-popup-type
@@ -1738,7 +1739,7 @@ cell" el)))))
17381739
(description group local hl-face &optional original-description)
17391740
"Add face to DESCRIPTION.
17401741
The face chosen depends on whether the description represents a
1741-
group or a command. Also make some minor adjustments to the
1742+
group or a command. Also make some minor adjustments to the
17421743
description string, like removing a \"group:\" prefix.
17431744
17441745
ORIGINAL-DESCRIPTION is the description given by
@@ -1813,7 +1814,7 @@ return the docstring."
18131814
"Make list of key bindings with separators and descriptions.
18141815
Take a list of (key . desc) cons cells in UNFORMATTED, add
18151816
faces and perform replacements according to the three replacement
1816-
alists. Returns a list (key separator description)."
1817+
alists. Return a list (key separator description)."
18171818
(let ((sep-w-face
18181819
(which-key--propertize which-key-separator
18191820
'face 'which-key-separator-face))
@@ -1949,8 +1950,8 @@ EVIL is non-nil, extract active evil bidings."
19491950
(defun which-key--get-bindings (&optional prefix keymap filter recursive)
19501951
"Collect key bindings.
19511952
If KEYMAP is nil, collect from current buffer using the current
1952-
key sequence as a prefix. Otherwise, collect from KEYMAP. FILTER
1953-
is a function to use to filter the bindings. If RECURSIVE is
1953+
key sequence as a prefix. Otherwise, collect from KEYMAP. FILTER
1954+
is a function to use to filter the bindings. If RECURSIVE is
19541955
non-nil, then bindings are collected recursively for all prefixes."
19551956
(let* ((unformatted
19561957
(cond ((keymapp keymap)
@@ -2020,7 +2021,7 @@ that width."
20202021

20212022
(defun which-key--list-to-pages (keys avl-lines avl-width)
20222023
"Convert list of KEYS to columns based on dimensions AVL-LINES and AVL-WIDTH.
2023-
Returns a `which-key--pages' object that holds the page strings,
2024+
Return a `which-key--pages' object that holds the page strings,
20242025
as well as metadata."
20252026
(let ((cols-w-widths (mapcar (lambda (c) (which-key--pad-column c avl-width))
20262027
(which-key--partition-list avl-lines keys)))
@@ -2063,7 +2064,7 @@ as well as metadata."
20632064
(keys available-lines available-width &optional min-lines vertical)
20642065
"Create page strings using `which-key--list-to-pages'.
20652066
Will try to find the best number of rows and columns using the
2066-
given dimensions and the length and widths of ITEMS. Use VERTICAL
2067+
given dimensions and the length and widths of ITEMS. Use VERTICAL
20672068
if the ITEMS are laid out vertically and the number of columns
20682069
should be minimized."
20692070
(let ((result (which-key--list-to-pages
@@ -2088,7 +2089,7 @@ should be minimized."
20882089
(defun which-key--create-pages (keys &optional prefix-keys prefix-title)
20892090
"Create page strings using `which-key--list-to-pages'.
20902091
Will try to find the best number of rows and columns using the
2091-
given dimensions and the length and wdiths of KEYS. SEL-WIN-WIDTH
2092+
given dimensions and the length and wdiths of KEYS. SEL-WIN-WIDTH
20922093
is the width of the live window."
20932094
(let* ((max-dims (which-key--popup-max-dimensions))
20942095
(max-lines (car max-dims))
@@ -2209,7 +2210,7 @@ Include prefix arguments."
22092210
(which-key--propertize dash 'face 'which-key-key-face)))))
22102211

22112212
(defun which-key--get-popup-map ()
2212-
"Generate transient-map for use in the top level binding display."
2213+
"Generate transient map for use in the top level binding display."
22132214
(unless which-key--automatic-display
22142215
(let ((map (make-sparse-keymap)))
22152216
(define-key map (kbd which-key-paging-key) #'which-key-C-h-dispatch)
@@ -2406,7 +2407,7 @@ Usually this is `describe-prefix-bindings'."
24062407
(defun which-key-show-major-mode (&optional all)
24072408
"Show top-level bindings in the map of the current major mode.
24082409
This function will also detect evil bindings made using
2409-
`evil-define-key' in this map. These bindings will depend on the
2410+
`evil-define-key' in this map. These bindings will depend on the
24102411
current evil state."
24112412
(interactive "P")
24122413
(let ((map-sym (intern (format "%s-map" major-mode))))

0 commit comments

Comments
 (0)