]> git.eshelyaron.com Git - emacs.git/commitdiff
Quote single quotes in docstrings or use different quoting
authorJonas Bernoulli <jonas@bernoul.li>
Mon, 8 Aug 2022 11:33:17 +0000 (13:33 +0200)
committerJonas Bernoulli <jonas@bernoul.li>
Mon, 8 Aug 2022 21:06:34 +0000 (23:06 +0200)
The byte-compiler started pointing this out:
  Warning: docstring has wrong usage of unescaped single
  quotes (use \= or different quoting)

lisp/use-package/bind-key.el
lisp/use-package/use-package-core.el
lisp/use-package/use-package-ensure.el

index df76c39ceed950542a70144affcfd827c08f877c..bf5785ff5b45a16718915f1d961c1e8d2b9243b5 100644 (file)
@@ -160,7 +160,7 @@ For example:
 
   (bind-key \"M-h\" #'some-interactive-function my-mode-map)
 
-  (bind-key \"M-h\" #'some-interactive-function 'my-mode-map)
+  (bind-key \"M-h\" #'some-interactive-function \\='my-mode-map)
 
 If PREDICATE is non-nil, it is a form evaluated to determine when
 a key should be bound. It must return non-nil in such cases.
@@ -262,16 +262,16 @@ Accepts keyword arguments:
 :repeat-docstring STR  - docstring for the repeat-map variable
 :repeat-map MAP        - name of the repeat map that should be created
                          for these bindings. If specified, the
-                         'repeat-map property of each command bound
-                         (within the scope of the :repeat-map keyword)
+                         `repeat-map' property of each command bound
+                         (within the scope of the `:repeat-map' keyword)
                          is set to this map.
-:exit BINDINGS         - Within the scope of :repeat-map will bind the
+:exit BINDINGS         - Within the scope of `:repeat-map' will bind the
                          key in the repeat map, but will not set the
-                         'repeat-map property of the bound command.
-:continue BINDINGS     - Within the scope of :repeat-map forces the
+                         `repeat-map' property of the bound command.
+:continue BINDINGS     - Within the scope of `:repeat-map' forces the
                          same behaviour as if no special keyword had
                          been used (that is, the command is bound, and
-                         it's 'repeat-map property set)
+                         it's `repeat-map' property set)
 :filter FORM           - optional form to determine when bindings apply
 
 The rest of the arguments are conses of keybinding string and a
@@ -409,16 +409,16 @@ Accepts keyword arguments:
 :repeat-docstring STR  - docstring for the repeat-map variable
 :repeat-map MAP        - name of the repeat map that should be created
                          for these bindings. If specified, the
-                         'repeat-map property of each command bound
-                         (within the scope of the :repeat-map keyword)
+                         `repeat-map' property of each command bound
+                         (within the scope of the `:repeat-map' keyword)
                          is set to this map.
-:exit BINDINGS         - Within the scope of :repeat-map will bind the
+:exit BINDINGS         - Within the scope of `:repeat-map' will bind the
                          key in the repeat map, but will not set the
-                         'repeat-map property of the bound command.
-:continue BINDINGS     - Within the scope of :repeat-map forces the
+                         `repeat-map' property of the bound command.
+:continue BINDINGS     - Within the scope of `:repeat-map' forces the
                          same behaviour as if no special keyword had
                          been used (that is, the command is bound, and
-                         it's 'repeat-map property set)
+                         it's `repeat-map' property set)
 :filter FORM           - optional form to determine when bindings apply
 
 The rest of the arguments are conses of keybinding string and a
index 2859e3382cadd7950fbfc91ec102f41995ee278f..ab35131e4f4380e802339d0b5a9650ad3853aaa7 100644 (file)
@@ -908,12 +908,12 @@ If RECURSED is non-nil, recurse into sublists."
   "A predicate that recognizes functional constructions:
   nil
   sym
-  'sym
+  \\='sym
   (quote sym)
   #'sym
   (function sym)
   (lambda () ...)
-  '(lambda () ...)
+  \\='(lambda () ...)
   (quote (lambda () ...))
   #'(lambda () ...)
   (function (lambda () ...))"
index 50005a9e9901980769e2ca386c835bef5e26dbd4..cb31b4b7dd424eeefb8e03179bea763c6f75f2ad 100644 (file)
@@ -93,7 +93,7 @@ The default value uses package.el to install the package."
 (defun use-package-archive-exists-p (archive)
   "Check if a given ARCHIVE is enabled.
 
-ARCHIVE can be a string or a symbol or 'manual to indicate a
+ARCHIVE can be a string or a symbol or `manual' to indicate a
 manually updated package."
   (if (member archive '(manual "manual"))
       't