branch: elpa/clojure-ts-mode
commit c7c7550f04d2191ec3371d90f1549e43dae1db2e
Author: Bozhidar Batsov <bozhi...@batsov.dev>
Commit: Bozhidar Batsov <bozhi...@batsov.dev>
Appease checkdoc
---
clojure-ts-mode.el | 6 +++---
test/clojure-ts-mode-indentation-test.el | 2 +-
test/test-helper.el | 2 +-
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/clojure-ts-mode.el b/clojure-ts-mode.el
index a5b504bcbb..c2dd69b7fb 100644
--- a/clojure-ts-mode.el
+++ b/clojure-ts-mode.el
@@ -833,7 +833,7 @@ Skip the optional metadata node at pos 0 if present."
t)))
(defun clojure-ts--first-value-child (node)
- "Returns the first value child of the given NODE.
+ "Return the first value child of the given NODE.
In the syntax tree, there are a few types of possible child nodes:
unnamed standalone nodes (e.g., comments), anonymous nodes (e.g.,
@@ -885,7 +885,7 @@ See `clojure-ts--definition-node-p' when an exact match is
possible."
(defun clojure-ts--standard-definition-node-name (node)
"Return the definition name for the given NODE.
-Returns nil if NODE is not a list with symbols as the first two
+Return nil if NODE is not a list with symbols as the first two
children. For example the node representing the expression (def foo 1)
would return foo. The node representing (ns user) would return user.
Does not do any matching on the first symbol (def, defn, etc), so
@@ -909,7 +909,7 @@ Can be called directly, but intended for use as
`treesit-defun-name-function'."
(defun clojure-ts--kwd-definition-node-name (node)
"Return the keyword name for the given NODE.
-Returns nil if NODE is not a list where the first element is a symbol
+Return nil if NODE is not a list where the first element is a symbol
and the second is a keyword. For example, a node representing the
expression (s/def ::foo int?) would return foo.
diff --git a/test/clojure-ts-mode-indentation-test.el
b/test/clojure-ts-mode-indentation-test.el
index bda3538b9e..d158ed8469 100644
--- a/test/clojure-ts-mode-indentation-test.el
+++ b/test/clojure-ts-mode-indentation-test.el
@@ -124,7 +124,7 @@ DESCRIPTION is a string with the description of the spec."
;; Mock `cider--get-symbol-indent' function
(defun cider--get-symbol-indent-mock (symbol-name)
- "Returns static mocked indentation specs for SYMBOL-NAME if available."
+ "Return static mocked indentation specs for SYMBOL-NAME if available."
(when (stringp symbol-name)
(cond
((string-equal symbol-name "my-with-in-str") 1)
diff --git a/test/test-helper.el b/test/test-helper.el
index fa821e64b9..f1515d9296 100644
--- a/test/test-helper.el
+++ b/test/test-helper.el
@@ -48,7 +48,7 @@ and point left there."
,@body)))
(defun clojure-ts--s-index-of (needle s &optional ignore-case)
- "Returns first index of NEEDLE in S, or nil.
+ "Return first index of NEEDLE in S, or nil.
If IGNORE-CASE is non-nil, the comparison is done without paying
attention to case differences."
