diff options
| author | Stefan Kangas <stefan@marxist.se> | 2022-07-09 10:54:01 +0200 |
|---|---|---|
| committer | Stefan Kangas <stefan@marxist.se> | 2022-07-09 11:47:52 +0200 |
| commit | ecb2eccad56518992426500dd8119024ea8288a8 (patch) | |
| tree | a927f2f1fac478d0e5170dea294a6aa875b12c55 /lisp/emacs-lisp/ert.el | |
| parent | d74dad673b854b011b23853d298c9a8f86d2d6ad (diff) | |
| download | emacs-ecb2eccad56518992426500dd8119024ea8288a8.tar.gz emacs-ecb2eccad56518992426500dd8119024ea8288a8.tar.bz2 emacs-ecb2eccad56518992426500dd8119024ea8288a8.zip | |
Improve ert-test-erts-file documentation
* lisp/emacs-lisp/ert.el (ert-test-erts-file): Improve docstring.
* doc/misc/ert.texi (erts files): Fix typo.
Diffstat (limited to 'lisp/emacs-lisp/ert.el')
| -rw-r--r-- | lisp/emacs-lisp/ert.el | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/lisp/emacs-lisp/ert.el b/lisp/emacs-lisp/ert.el index 21bee4c6d8b..49b54c2d00f 100644 --- a/lisp/emacs-lisp/ert.el +++ b/lisp/emacs-lisp/ert.el @@ -2880,8 +2880,14 @@ To be used in the ERT results buffer." nil) (defun ert-test-erts-file (file &optional transform) - "Parse FILE as a file containing before/after parts. -TRANSFORM will be called to get from before to after." + "Parse FILE as a file containing before/after parts (an erts file). + +This function puts the \"before\" section of an .erts file into a +temporary buffer, calls the TRANSFORM function, and then compares +the result with the \"after\" section. + +See Info node `(ert) erts files' for more information on how to +write erts files." (with-temp-buffer (insert-file-contents file) (let ((gen-specs (list (cons 'dummy t) |