branch: elpa/cider
commit 82b5ebaeb75b6478ed7737fbff2ba0f593735d74
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Fix docstring quoting to use proper Emacs conventions
Use backtick-apostrophe (\`symbol') for Lisp symbol references in
docstrings instead of plain single quotes ('symbol), which triggers
byte-compiler warnings. For English phrases, either drop the quotes
or use escaped quotes where literal code is shown.
---
lisp/cider-common.el | 2 +-
lisp/cider-completion.el | 4 ++--
lisp/cider-debug.el | 4 ++--
lisp/cider-inspector.el | 4 ++--
lisp/cider-macroexpansion.el | 6 +++---
lisp/cider-overlays.el | 10 +++++-----
lisp/cider-test.el | 2 +-
lisp/cider-util.el | 12 ++++++------
lisp/cider.el | 14 +++++++-------
9 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/lisp/cider-common.el b/lisp/cider-common.el
index fffe26d529b..189e76bf59f 100644
--- a/lisp/cider-common.el
+++ b/lisp/cider-common.el
@@ -293,7 +293,7 @@ in the container, the alist would be `((\"/src\"
\"~/projects/foo/src\"))."
"Attempt to translate the PATH in the given DIRECTION, optionally RETURN-ALL.
Looks at `cider-path-translations' for (container . host) alist of path
prefixes and translates PATH from container to host or vice-versa depending on
-whether DIRECTION is 'from-nrepl or 'to-nrepl."
+whether DIRECTION is `from-nrepl' or `to-nrepl'."
(seq-let [from-fn to-fn path-fn] (cond ((eq direction 'from-nrepl) '(car cdr
identity))
((eq direction 'to-nrepl) '(cdr car
expand-file-name)))
(let ((f (lambda (translation)
diff --git a/lisp/cider-completion.el b/lisp/cider-completion.el
index ccf77850e82..01568949ca0 100644
--- a/lisp/cider-completion.el
+++ b/lisp/cider-completion.el
@@ -104,8 +104,8 @@ backend, and ABBREVIATION is a short form of that type."
(defcustom cider-completion-annotations-include-ns 'unqualified
"Controls passing of namespaces to `cider-annotate-completion-function'.
-When set to 'always, the candidate's namespace will always be passed if it
-is available. When set to 'unqualified, the namespace will only be passed
+When set to `always', the candidate's namespace will always be passed if it
+is available. When set to `unqualified', the namespace will only be passed
if the candidate is not namespace-qualified."
:type '(choice (const always)
(const unqualified)
diff --git a/lisp/cider-debug.el b/lisp/cider-debug.el
index 015f5c73603..5b48a0622ba 100644
--- a/lisp/cider-debug.el
+++ b/lisp/cider-debug.el
@@ -208,7 +208,7 @@ list."
:type '(alist :key-type character
:value-type (list
(string :tag "command name")
- (choice (string :tag "display name") nil)))
+ (choice (string :tag "display name") (const
nil))))
:package-version '(cider . "0.24.0"))
(defun cider--debug-format-locals-list (locals)
@@ -505,7 +505,7 @@ REASON is a keyword describing why this buffer was
necessary."
COORDINATES is a list of integers that specify how to navigate into the
sexp that is after point when this function is called.
-As an example, a COORDINATES list of '(1 0 2) means:
+As an example, a COORDINATES list of (1 0 2) means:
- enter next sexp then `forward-sexp' once,
- enter next sexp,
- enter next sexp then `forward-sexp' twice.
diff --git a/lisp/cider-inspector.el b/lisp/cider-inspector.el
index 4c504b9c835..5f89edb359f 100644
--- a/lisp/cider-inspector.el
+++ b/lisp/cider-inspector.el
@@ -54,7 +54,7 @@ The page size can be also changed interactively within the
inspector."
(defcustom cider-inspector-max-atom-length 150
"Default max length of nested atoms before they are truncated.
-'Atom' here means any collection member that satisfies (complement coll?).
+Atom here means any collection member that satisfies (complement coll?).
The max length can be also changed interactively within the inspector."
:type '(integer :tag "Max atom length" 150)
:package-version '(cider . "1.1.0"))
@@ -621,7 +621,7 @@ from stack), `:next-inspectable' (move point to next
inspectable object)."
(defun cider-find-inspectable-object (direction limit)
"Find the next/previous inspectable object.
-DIRECTION can be either 'next or 'prev.
+DIRECTION can be either `next' or `prev'.
LIMIT is the maximum or minimum position in the current buffer.
Return a list of two values: If an object could be found, the
diff --git a/lisp/cider-macroexpansion.el b/lisp/cider-macroexpansion.el
index 2e756950a1b..969a003fc9b 100644
--- a/lisp/cider-macroexpansion.el
+++ b/lisp/cider-macroexpansion.el
@@ -40,9 +40,9 @@
"Determines if namespaces are displayed in the macroexpansion buffer.
Possible values are:
- 'qualified ;=> Vars are fully-qualified in the expansion
- 'none ;=> Vars are displayed without namespace qualification
- 'tidy ;=> Vars that are :refer-ed or defined in the current namespace
are
+ `qualified' ;=> Vars are fully-qualified in the expansion
+ `none' ;=> Vars are displayed without namespace qualification
+ `tidy' ;=> Vars that are :refer-ed or defined in the current namespace
are
displayed with their simple name, non-referred vars from other
namespaces are referred using the alias for that namespace (if
defined), other vars are displayed fully qualified."
diff --git a/lisp/cider-overlays.el b/lisp/cider-overlays.el
index 57f5c59c51f..78c7deb8898 100644
--- a/lisp/cider-overlays.el
+++ b/lisp/cider-overlays.el
@@ -85,11 +85,11 @@ see `cider-debug-use-overlays'."
(defcustom cider-result-overlay-position 'at-eol
"Where to display result overlays for inline evaluation and the debugger.
-If 'at-eol, display at the end of the line.
-If 'at-point, display at the end of the respective sexp."
+If `at-eol', display at the end of the line.
+If `at-point', display at the end of the respective sexp."
:group 'cider
- :type ''(choice (const :tag "End of line" at-eol)
- (const :tag "End of sexp" at-point))
+ :type '(choice (const :tag "End of line" at-eol)
+ (const :tag "End of sexp" at-point))
:package-version '(cider . "0.23.0"))
(defcustom cider-eval-result-prefix "=> "
@@ -122,7 +122,7 @@ Never throws errors, and can be used in an overlay's
modification-hooks."
"Place an overlay between L and R and return it.
TYPE is a symbol put on the overlay's category property. It is used to
easily remove all overlays from a region with:
- (remove-overlays start end 'category TYPE)
+ (remove-overlays start end \\='category TYPE)
PROPS is a plist of properties and values to add to the overlay."
(let ((o (make-overlay l (or r l) (current-buffer))))
(overlay-put o 'category type)
diff --git a/lisp/cider-test.el b/lisp/cider-test.el
index a8b440ee317..6d5c346a1e0 100644
--- a/lisp/cider-test.el
+++ b/lisp/cider-test.el
@@ -325,7 +325,7 @@ N = 1 => 3, N = 2 => 4, etc."
(defun cider-test-ediff ()
"Show diff of the expected vs actual value for the test at point.
-With the actual value, the outermost '(not ...)' s-expression is removed."
+With the actual value, the outermost `(not ...)' s-expression is removed."
(interactive)
(let* ((expected-buffer (generate-new-buffer " *expected*"))
(actual-buffer (generate-new-buffer " *actual*"))
diff --git a/lisp/cider-util.el b/lisp/cider-util.el
index 157c1560d3d..cce8f6e85f7 100644
--- a/lisp/cider-util.el
+++ b/lisp/cider-util.el
@@ -98,8 +98,8 @@ Setting this to nil removes the fontification restriction."
(nth 4 (parse-partial-sexp beg (point)))))
(defun cider--tooling-file-p (file-name)
- "Return t if FILE-NAME is not a 'real' source file.
-Currently, only check if the relative file name starts with 'form-init'
+ "Return t if FILE-NAME is not a real source file.
+Currently, only check if the relative file name starts with `form-init'
which nREPL uses for temporary evaluation file names."
(let ((fname (file-name-nondirectory file-name)))
(string-match-p "^form-init" fname)))
@@ -252,13 +252,13 @@ Can only error if SKIP is non-nil."
"Extract PROP from PLIST using `equal'.
An alternative `lax-plist-get' that got deprecated in Emacs 29."
- (lax-plist-get plist prop))
+ (plist-get plist prop #'equal))
(defun cider-plist-put (plist prop val)
"Change value in PLIST of PROP to VAL, comparing with `equal'.
An alternative to `lax-plist-put' that got deprecated in Emacs 29."
- (lax-plist-put plist prop val))
+ (plist-put plist prop val #'equal))
;;; Text properties
@@ -449,13 +449,13 @@ objects."
candidates))
(defun cider-add-to-alist (symbol car cadr)
- "Add '(CAR CADR) to the alist stored in SYMBOL.
+ "Add (CAR CADR) to the alist stored in SYMBOL.
If CAR already corresponds to an entry in the alist, destructively replace
the entry's second element with CADR.
This can be used, for instance, to update the version of an injected
plugin or dependency with:
- (cider-add-to-alist 'cider-jack-in-lein-plugins
+ (cider-add-to-alist \\='cider-jack-in-lein-plugins
\"plugin/artifact-name\" \"THE-NEW-VERSION\")"
(let ((alist (symbol-value symbol)))
(if-let* ((cons (assoc car alist)))
diff --git a/lisp/cider.el b/lisp/cider.el
index 48a42475f71..0214b407ff7 100644
--- a/lisp/cider.el
+++ b/lisp/cider.el
@@ -356,7 +356,7 @@ The plist supports the following keys
- :cmd a plist of instructions how to invoke the jack in command, with keys
- - :jack-in-type 'clj to start a clj repl and 'cljs for a cljs repl.
+ - :jack-in-type `clj' to start a clj repl and `cljs' for a cljs repl.
- &rest the same set of params supported by the `cider-jack-in-clj' and
`cider-jack-in-cljs' commands.")
@@ -1231,7 +1231,7 @@ double prefix prompt for all these parameters."
(defun cider-jack-in-cljs (params)
"Start an nREPL server for the current project and connect to it.
PARAMS is a plist optionally containing :project-dir, :jack-in-cmd and
-:cljs-repl-type (e.g. 'shadow, 'node, 'figwheel, etc).
+:cljs-repl-type (e.g. `shadow', `node', `figwheel', etc).
With the prefix argument,
allow editing of the jack in command; with a double prefix prompt for all
@@ -1257,7 +1257,7 @@ these parameters."
(defun cider-jack-in-clj&cljs (&optional params soft-cljs-start)
"Start an nREPL server and connect with clj and cljs REPLs.
PARAMS is a plist optionally containing :project-dir, :jack-in-cmd and
-:cljs-repl-type (e.g. 'shadow, 'node, 'fighweel, etc).
+:cljs-repl-type (e.g. `shadow', `node', `figwheel', etc).
With the prefix argument, allow for editing of the jack in command;
with a double prefix prompt for all these parameters.
@@ -1311,8 +1311,8 @@ server is created."
;;;###autoload
(defun cider-connect-sibling-cljs (params &optional other-repl)
"Create a ClojureScript REPL with the same server as OTHER-REPL.
-PARAMS is a plist optionally containing :cljs-repl-type (e.g. 'node,
-'figwheel, 'shadow, etc).
+PARAMS is a plist optionally containing :cljs-repl-type (e.g. `node',
+`figwheel', `shadow', etc).
All other parameters are inferred from the OTHER-REPL.
OTHER-REPL defaults to `cider-current-repl' but in programs can also be a
@@ -1392,7 +1392,7 @@ their supplied or default values."
(defun cider-connect-cljs (&optional params)
"Initialize a ClojureScript connection to an nREPL server.
PARAMS is a plist optionally containing :host, :port, :project-dir and
-:cljs-repl-type (e.g. 'shadow, 'node, 'figwheel, etc).
+:cljs-repl-type (e.g. `shadow', `node', `figwheel', etc).
If nil, use the default parameters in `cider-connect-default-params' or
`cider-connect-default-cljs-params'.
@@ -1416,7 +1416,7 @@ their supplied or default values."
(defun cider-connect-clj&cljs (params &optional soft-cljs-start)
"Initialize a Clojure and ClojureScript connection to an nREPL server.
PARAMS is a plist optionally containing :host, :port, :project-dir and
-:cljs-repl-type (e.g. 'shadow, 'node, 'figwheel, etc).
+:cljs-repl-type (e.g. `shadow', `node', `figwheel', etc).
If nil, use the default parameters in `cider-connect-default-params' and
`cider-connect-default-cljs-params'.
