branch: externals/avy
commit 8576155193d57596a37bbec16b0dd39b71e47fc1
Author: Javier Olaechea <pir...@gmail.com>
Commit: Javier Olaechea <pir...@gmail.com>
Quote symbols in docstrings according to conventions
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
---
avy.el | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/avy.el b/avy.el
index 4c94a309a7..0ccd056768 100644
--- a/avy.el
+++ b/avy.el
@@ -395,7 +395,7 @@ SEQ-LEN is how many elements of KEYS it takes to identify a
match."
(defvar avy-command nil
"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)
"Coerce LST into a balanced tree.
@@ -933,14 +933,14 @@ multiple OVERLAY-FN invocations."
(null (assoc invisible buffer-invisibility-spec)))))
(defun avy--next-visible-point ()
- "Return the next closest point without 'invisible property."
+ "Return the next closest point without `invisible' property."
(let ((s (point)))
(while (and (not (= (point-max) (setq s (next-char-property-change s))))
(not (avy--visible-p s))))
s))
(defun avy--next-invisible-point ()
- "Return the next closest point with 'invisible property."
+ "Return the next closest point with `invisible' property."
(let ((s (point)))
(while (and (not (= (point-max) (setq s (next-char-property-change s))))
(avy--visible-p s)))
