ld/avy
1
0
Fork 0
mirror of https://github.com/abo-abo/avy.git synced 2025-10-13 13:33:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Quote symbols in docstrings according to conventions

Browse Source 
This silences the following warnings during byte-compilation:

avy.el:396:2: Warning: defvar `avy-command' docstring has wrong usage of
    unescaped single quotes (use \= or different quoting)

In avy--next-visible-point:
avy.el:935:2: Warning: docstring has wrong usage of unescaped single quotes
    (use \= or different quoting)

In avy--next-invisible-point:
avy.el:942:2: Warning: docstring has wrong usage of unescaped single quotes
    (use \= or different quoting)

This convention is documented in the Documentation Tips section of the Elisp manual

> • When a documentation string refers to a Lisp symbol, write it as it
>   would be printed (which usually means in lower case), with a grave
>   accent ‘`’ before and apostrophe ‘'’ after it.  There are two
>   exceptions: write ‘t’ and ‘nil’ without surrounding punctuation.

See:
- (info "(elisp)Documentaion Tips")
- https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html
This commit is contained in:
Javier Olaechea 2023-03-16 17:31:39 -05:00
parent 955c8dedd6
commit 8576155193
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
avy.el
View File

@ -395,7 +395,7 @@ SEQ-LEN is how many elements of KEYS it takes to identify a match."
(defvar avy-command nil (defvar avy-command nil
"Store the current command symbol. "Store the current command symbol.
E.g. 'avy-goto-line or 'avy-goto-char.") E.g. `avy-goto-line' or `avy-goto-char'.")
(defun avy-tree (lst keys) (defun avy-tree (lst keys)
"Coerce LST into a balanced tree. "Coerce LST into a balanced tree.
@ -933,14 +933,14 @@ multiple OVERLAY-FN invocations."
(null (assoc invisible buffer-invisibility-spec))))) (null (assoc invisible buffer-invisibility-spec)))))
(defun avy--next-visible-point () (defun avy--next-visible-point ()
"Return the next closest point without 'invisible property." "Return the next closest point without `invisible' property."
(let ((s (point))) (let ((s (point)))
(while (and (not (= (point-max) (setq s (next-char-property-change s)))) (while (and (not (= (point-max) (setq s (next-char-property-change s))))
(not (avy--visible-p s)))) (not (avy--visible-p s))))
s)) s))
(defun avy--next-invisible-point () (defun avy--next-invisible-point ()
"Return the next closest point with 'invisible property." "Return the next closest point with `invisible' property."
(let ((s (point))) (let ((s (point)))
(while (and (not (= (point-max) (setq s (next-char-property-change s)))) (while (and (not (= (point-max) (setq s (next-char-property-change s))))
(avy--visible-p s))) (avy--visible-p s)))