[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/buttercup 966798f 255/340: Correct all docstrings to pass
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/buttercup 966798f 255/340: Correct all docstrings to pass checkdoc |
Date: |
Thu, 16 Dec 2021 14:59:45 -0500 (EST) |
branch: elpa/buttercup
commit 966798fa05ebbc8500bedd037159b1baf39ffa9b
Author: Ola Nilsson <ola.nilsson@gmail.com>
Commit: Ola Nilsson <ola.nilsson@gmail.com>
Correct all docstrings to pass checkdoc
---
buttercup.el | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/buttercup.el b/buttercup.el
index 62a7332..d4ec9bf 100644
--- a/buttercup.el
+++ b/buttercup.el
@@ -237,7 +237,6 @@ failed."
ARGS is a list of functions that must be `funcall'ed to get their
values.
-
MATCHER is either a matcher keyword defined with
`buttercup-define-matcher', or a function."
(cl-assert (cl-every #'buttercup--wrapper-fun-p args) t)
@@ -246,19 +245,20 @@ MATCHER is either a matcher keyword defined with
(apply function args)))
(cl-defmacro buttercup--test-expectation
- (expr &key expect-match-phrase expect-mismatch-phrase)
+ (expression &key expect-match-phrase expect-mismatch-phrase)
"Wrapper for the common matcher case of two possible messages.
The logic for the return values of buttercup matchers can be
unintuitive, since the return value is a cons cell whose first
element is t for a mismatch and nil for a match. In the simple
-case where there are only two possible messages (one for a match
-and one for a mismatch), this macro allows you to simply specify
-those two phrases and the expression to test."
+case where there are only two possible
+messages (EXPECT-MATCH-PHRASE for a match and
+EXPECT-MISMATCH-PHRASE for a mismatch), this macro allows you to
+simply specify those two phrases and the EXPRESSION to test."
(declare (indent 1))
(cl-assert expect-match-phrase)
(cl-assert expect-mismatch-phrase)
- `(let ((value ,expr))
+ `(let ((value ,expression))
(if value
(cons t ,expect-mismatch-phrase)
(cons nil ,expect-match-phrase))))
@@ -266,7 +266,7 @@ those two phrases and the expression to test."
(cl-defmacro buttercup-define-matcher-for-unary-function
(matcher function &key
expect-match-phrase expect-mismatch-phrase function-name)
- "Shortcut to define a macther for a 1-argument function.
+ "Shortcut to define a MATCHER for a 1-argument FUNCTION.
When the matcher is used, keyword arguments EXPECT-MATCH-PHRASE
and EXPECT-MISMATCH-PHRASE are used to construct the return
@@ -340,7 +340,7 @@ See also `buttercup-define-matcher'."
(cl-defmacro buttercup-define-matcher-for-binary-function
(matcher function &key
expect-match-phrase expect-mismatch-phrase function-name)
- "Shortcut to define a macther for a 2-argument function.
+ "Shortcut to define a MATCHER for a 2-argument FUNCTION.
When the matcher is used, keyword arguments EXPECT-MATCH-PHRASE
and EXPECT-MISMATCH-PHRASE are used to construct the return
@@ -1152,7 +1152,7 @@ responsibility to ensure ARG is a command."
(fset spy (buttercup--make-spy fun)))))
(defun buttercup--make-spy (fun)
- "Create a new spy function wrapping FUN and tracking calls to itself."
+ "Create a new spy function wrapping FUN and tracking every call to itself."
(let (this-spy-function)
(setq
this-spy-function
@@ -1209,12 +1209,12 @@ in a `buttercup-with-cleanup' environment.")
(cons function buttercup--cleanup-functions))))
(defun spy-calls-all (spy)
- "Return the contexts of calls to SPY."
+ "Return all call contexts for SPY."
(gethash (symbol-function spy)
buttercup--spy-contexts))
(defun buttercup--spy-calls-add (spy-function context)
- "Add CONTEXT to the recorded calls to SPY-FUNCTION."
+ "Add CONTEXT to the call records for SPY-FUNCTION."
(puthash spy-function
(append (gethash spy-function
buttercup--spy-contexts)
@@ -1222,7 +1222,7 @@ in a `buttercup-with-cleanup' environment.")
buttercup--spy-contexts))
(defun spy-calls-reset (spy)
- "Reset SPY, removing all recorded calls."
+ "Reset SPY, removing all stored contexts."
(puthash (symbol-function spy)
nil
buttercup--spy-contexts))
@@ -1259,7 +1259,7 @@ in a `buttercup-with-cleanup' environment.")
nil)))
(defun spy-calls-all-args (spy)
- "Return the arguments to all calls to SPY."
+ "Return the arguments for every recorded call to SPY."
(mapcar 'spy-context-args (spy-calls-all spy)))
(defun spy-calls-most-recent (spy)
- [nongnu] elpa/buttercup c720cef 233/340: Merge pull request #146 from DarwinAwardWinner/spy-record-errors, (continued)
- [nongnu] elpa/buttercup c720cef 233/340: Merge pull request #146 from DarwinAwardWinner/spy-record-errors, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup b2edd35 235/340: Change: (buttercup-define-matcher-for-binary-function) Add newlines, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 818c150 239/340: docs: Clarify the difference between :var and `let', ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup d8ab09d 244/340: Update documentation for the --pattern option in running-tests.md, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup adba24e 246/340: Bump version: 1.19 → 1.20, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup e7e5d22 248/340: Add an option to immediately abort Buttercup run if a test fails, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup dcc2638 249/340: Revert "Add an option to immediately abort Buttercup run if a test fails", ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 9b30c75 252/340: Make buttercup-x?it and buttercup-suite-add-child return spec, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 3734152 251/340: Make buttercup-describe return the created suite object, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 8271c27 254/340: Only update spec state if it is worse or equal, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 966798f 255/340: Correct all docstrings to pass checkdoc,
ELPA Syncer <=
- [nongnu] elpa/buttercup b520dcf 257/340: Print test run duration in an apropriate unit, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 1fd0d8b 260/340: Set state pending for skipped specs for correct initial count, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup b298517 262/340: test: Mark some local function arguments as unused, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 8e29f4c 259/340: Extract buttercup--mark-skipped from buttercup-run-discover, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 669ca99 267/340: test: Split make rule test into test-buttercup and test-docs, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 6655f77 269/340: Update test run duration output in buttercup-reporter-batch, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 0e6c09e 271/340: Correct the assume docstring, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 6848057 167/340: Bump version: 1.9 → 1.10, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 8628d45 208/340: Merge pull request #147 from snogge/suite-local-function, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup a6f2486 211/340: Merge pull request #150 from DarwinAwardWinner/suppress-warning-redirect, ELPA Syncer, 2021/12/16