[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master a5b8140: Improve docstrings of ert-resource-{directory, file}
From: |
Stefan Kangas |
Subject: |
master a5b8140: Improve docstrings of ert-resource-{directory, file} |
Date: |
Tue, 28 Sep 2021 08:32:33 -0400 (EDT) |
branch: master
commit a5b8140d4e5866b7e9e3fe88c0cd4b7914c949a5
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>
Improve docstrings of ert-resource-{directory,file}
* lisp/emacs-lisp/ert-x.el (ert-resource-directory)
(ert-resource-file): Improve docstrings.
---
lisp/emacs-lisp/ert-x.el | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/lisp/emacs-lisp/ert-x.el b/lisp/emacs-lisp/ert-x.el
index 59ec4d2..3fc57d5 100644
--- a/lisp/emacs-lisp/ert-x.el
+++ b/lisp/emacs-lisp/ert-x.el
@@ -361,10 +361,11 @@ in the same directory as the test file this is called
from.
If that directory doesn't exist, find a directory based on the
test file name. If the file is named \"foo-tests.el\", return
-the absolute file name for \"foo-resources\". If you want a
-different resource directory naming scheme, set the variable
-`ert-resource-directory-format'. Before formatting, the file
-name will be trimmed using `string-trim' with arguments
+the absolute file name for \"foo-resources\".
+
+If you want a different resource directory naming scheme, set the
+variable `ert-resource-directory-format'. Before formatting, the
+file name will be trimmed using `string-trim' with arguments
`ert-resource-directory-trim-left-regexp' and
`ert-resource-directory-trim-right-regexp'."
`(let* ((testfile ,(or (macroexp-file-name)
@@ -380,9 +381,9 @@ name will be trimmed using `string-trim' with arguments
ert-resource-directory-trim-right-regexp)))))))
(defmacro ert-resource-file (file)
- "Return file name of resource file named FILE.
-A resource file is in the resource directory as per
-`ert-resource-directory'."
+ "Return absolute file name of resource (test data) file named FILE.
+A resource file is defined as any file placed in the resource
+directory as returned by `ert-resource-directory'."
`(expand-file-name ,file (ert-resource-directory)))
(provide 'ert-x)
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master a5b8140: Improve docstrings of ert-resource-{directory, file},
Stefan Kangas <=