From 8bb28e740dd2cc8058d7833dd60b0ef9a8765c1b Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sun, 26 Sep 2021 01:53:56 +0200 Subject: [PATCH] ; Minor stylistic checkdoc fixes in test/**/*.el --- test/lisp/autorevert-tests.el | 2 +- test/lisp/calc/calc-tests.el | 4 +-- test/lisp/calculator-tests.el | 2 +- test/lisp/calendar/cal-french-tests.el | 1 + test/lisp/calendar/icalendar-tests.el | 2 +- test/lisp/calendar/solar-tests.el | 4 +++ test/lisp/calendar/todo-mode-tests.el | 2 +- test/lisp/cedet/semantic-utest-c.el | 2 +- test/lisp/cedet/semantic-utest-ia.el | 2 +- test/lisp/cedet/semantic-utest.el | 7 ++-- test/lisp/cedet/semantic/fw-tests.el | 2 +- test/lisp/comint-tests.el | 4 +-- test/lisp/cus-edit-tests.el | 2 +- test/lisp/dabbrev-tests.el | 2 ++ test/lisp/descr-text-tests.el | 2 +- test/lisp/dired-aux-tests.el | 2 +- test/lisp/dired-tests.el | 2 +- test/lisp/dired-x-tests.el | 2 +- test/lisp/electric-tests.el | 2 +- test/lisp/emacs-lisp/bytecomp-tests.el | 4 +-- test/lisp/emacs-lisp/cconv-tests.el | 6 ++-- .../eieio-tests/eieio-test-methodinvoke.el | 20 ++++++----- .../eieio-tests/eieio-test-persist.el | 6 ++-- .../emacs-lisp/eieio-tests/eieio-tests.el | 10 +++--- .../faceup-test-this-file-directory.el | 2 +- test/lisp/emacs-lisp/generator-tests.el | 2 +- test/lisp/emacs-lisp/let-alist-tests.el | 2 +- test/lisp/emacs-lisp/memory-report-tests.el | 2 ++ test/lisp/emacs-lisp/nadvice-tests.el | 2 +- .../macro-problem-package-1.0/macro-aux.el | 2 +- .../macro-problem.el | 4 +-- .../macro-problem-package-2.0/macro-aux.el | 4 +-- .../macro-problem.el | 8 ++--- .../newer-versions/simple-single-1.4.el | 6 ++-- .../signed/signed-bad-1.0.el | 6 ++-- .../signed/signed-good-1.0.el | 6 ++-- .../package-resources/simple-depend-1.0.el | 2 +- .../package-resources/simple-single-1.3.el | 6 ++-- .../simple-two-depend-1.1.el | 2 +- test/lisp/emacs-lisp/package-tests.el | 2 +- test/lisp/emacs-lisp/regexp-opt-tests.el | 2 +- test/lisp/emacs-lisp/rx-tests.el | 4 +++ test/lisp/emacs-lisp/shortdoc-tests.el | 4 +++ .../testcover-resources/testcases.el | 10 +++--- test/lisp/emacs-lisp/unsafep-tests.el | 2 +- test/lisp/erc/erc-tests.el | 2 ++ test/lisp/erc/erc-track-tests.el | 2 ++ test/lisp/eshell/eshell-tests.el | 2 +- .../faces-resources/faces-test-dark-theme.el | 2 +- .../faces-resources/faces-test-light-theme.el | 2 +- test/lisp/faces-tests.el | 2 +- test/lisp/gnus/gnus-search-tests.el | 2 +- test/lisp/gnus/gnus-util-tests.el | 2 +- test/lisp/gnus/message-tests.el | 2 +- test/lisp/htmlfontify-tests.el | 2 +- test/lisp/ibuffer-tests.el | 2 +- test/lisp/info-xref-tests.el | 2 +- test/lisp/international/ccl-tests.el | 2 ++ test/lisp/jit-lock-tests.el | 2 ++ test/lisp/kmacro-tests.el | 2 +- test/lisp/mail/rmail-tests.el | 2 +- test/lisp/mail/rmailmm-tests.el | 2 +- test/lisp/mail/uudecode-tests.el | 4 +-- test/lisp/net/shr-tests.el | 2 +- test/lisp/net/socks-tests.el | 2 +- test/lisp/net/tramp-tests.el | 2 +- test/lisp/newcomment-tests.el | 4 +-- test/lisp/org/org-tests.el | 2 ++ test/lisp/play/cookie1-tests.el | 2 +- test/lisp/progmodes/elisp-mode-tests.el | 36 +++++++++---------- test/lisp/progmodes/etags-tests.el | 2 ++ test/lisp/progmodes/flymake-tests.el | 2 +- test/lisp/progmodes/gdb-mi-tests.el | 4 +++ test/lisp/progmodes/opascal-tests.el | 2 ++ test/lisp/progmodes/pascal-tests.el | 4 +++ test/lisp/progmodes/sql-tests.el | 2 +- test/lisp/ps-print-tests.el | 2 ++ test/lisp/saveplace-tests.el | 2 ++ test/lisp/ses-tests.el | 2 ++ test/lisp/shell-tests.el | 2 +- test/lisp/simple-tests.el | 2 +- .../so-long-tests/so-long-tests-helpers.el | 4 +-- test/lisp/tar-mode-tests.el | 2 +- test/lisp/term/tty-colors-tests.el | 2 +- test/lisp/textmodes/dns-mode-tests.el | 2 ++ test/lisp/thingatpt-tests.el | 4 +-- test/lisp/time-stamp-tests.el | 6 ++-- test/lisp/time-tests.el | 2 ++ test/lisp/timezone-tests.el | 2 ++ test/lisp/url/url-parse-tests.el | 2 +- test/lisp/vc/add-log-tests.el | 4 +-- test/lisp/vc/diff-mode-tests.el | 1 + test/lisp/vc/smerge-mode-tests.el | 2 ++ test/lisp/vc/vc-bzr-tests.el | 2 +- test/lisp/whitespace-tests.el | 2 +- test/lisp/xml-tests.el | 4 +-- test/manual/biditest.el | 2 ++ test/manual/cedet/ede-tests.el | 2 +- test/manual/cedet/semantic-tests.el | 2 ++ test/manual/cedet/tests/test.el | 32 ++++++++--------- .../el-src/emacs/lisp/progmodes/etags.el | 2 +- test/manual/image-size-tests.el | 2 ++ test/manual/image-transforms-tests.el | 2 ++ test/manual/redisplay-testsuite.el | 2 ++ test/misc/test-custom-libs.el | 4 +-- test/src/alloc-tests.el | 2 ++ test/src/character-tests.el | 2 ++ test/src/charset-tests.el | 4 ++- test/src/coding-tests.el | 2 +- test/src/comp-resources/comp-test-funcs.el | 14 ++++---- test/src/comp-tests.el | 4 +-- test/src/data-tests.el | 22 ++++++------ test/src/decompress-tests.el | 2 +- test/src/fileio-tests.el | 12 ++++--- test/src/floatfns-tests.el | 4 +++ test/src/fns-tests.el | 2 ++ test/src/indent-tests.el | 2 ++ test/src/inotify-tests.el | 2 +- test/src/lcms-tests.el | 4 +-- test/src/marker-tests.el | 2 +- test/src/minibuf-tests.el | 4 +-- test/src/process-tests.el | 2 +- test/src/regex-emacs-tests.el | 28 +++++++-------- test/src/textprop-tests.el | 2 +- test/src/thread-tests.el | 8 ++--- test/src/timefns-tests.el | 2 ++ test/src/xfaces-tests.el | 4 +++ test/src/xml-tests.el | 2 +- 128 files changed, 302 insertions(+), 209 deletions(-) diff --git a/test/lisp/autorevert-tests.el b/test/lisp/autorevert-tests.el index a04610089c0..d0c52f6103f 100644 --- a/test/lisp/autorevert-tests.el +++ b/test/lisp/autorevert-tests.el @@ -688,4 +688,4 @@ This expects `auto-revert--messages' to be bound by (ert-run-tests-batch "^auto-revert-"))) (provide 'auto-revert-tests) -;;; auto-revert-tests.el ends here +;;; autorevert-tests.el ends here diff --git a/test/lisp/calc/calc-tests.el b/test/lisp/calc/calc-tests.el index 13dd228d3b3..8a78a068242 100644 --- a/test/lisp/calc/calc-tests.el +++ b/test/lisp/calc/calc-tests.el @@ -53,7 +53,7 @@ A and B should be calc expressions." (defun calc-tests-simple (fun string &rest args) "Push STRING on the calc stack, then call FUN and return the new top. -The result is a calc (i.e., lisp) expression, not its string representation. +The result is a calc (i.e., Lisp) expression, not its string representation. Also pop the entire stack afterwards. An existing calc stack is reused, otherwise a new one is created." (calc-eval string 'push) @@ -448,7 +448,7 @@ An existing calc stack is reused, otherwise a new one is created." ;; Generalisation for any n, integral k≥0: use falling product (/ (apply '* (number-sequence n (- n (1- k)) -1)) (calc-tests--fac k))) - (t (error "case not covered")))) + (t (error "Case not covered")))) (defun calc-tests--calc-to-number (x) "Convert a Calc object to a Lisp number." diff --git a/test/lisp/calculator-tests.el b/test/lisp/calculator-tests.el index 9551b1a4c61..f24ca97310c 100644 --- a/test/lisp/calculator-tests.el +++ b/test/lisp/calculator-tests.el @@ -48,4 +48,4 @@ (should (equal (calculator-string-to-number str) expected))))))) (provide 'calculator-tests) -;; calculator-tests.el ends here +;;; calculator-tests.el ends here diff --git a/test/lisp/calendar/cal-french-tests.el b/test/lisp/calendar/cal-french-tests.el index ab62c1e6fc1..1de5dea0882 100644 --- a/test/lisp/calendar/cal-french-tests.el +++ b/test/lisp/calendar/cal-french-tests.el @@ -111,3 +111,4 @@ (should (equal (calendar-french-date-string (list m d y)) str)))) (provide 'cal-french-tests) +;;; cal-french-tests.el ends here diff --git a/test/lisp/calendar/icalendar-tests.el b/test/lisp/calendar/icalendar-tests.el index de2a8917581..a1853ff3d4e 100644 --- a/test/lisp/calendar/icalendar-tests.el +++ b/test/lisp/calendar/icalendar-tests.el @@ -1636,7 +1636,7 @@ SUMMARY:NNN Wwwwwwww Wwwww - Aaaaaa Pppppppp rrrrrr ddd oo Nnnnnnnn 30 (format-time-string "%FT%T%z" (encode-time time) 0))) (defun icalendar-tests--decode-isodatetime (_ical-string) - "Test icalendar--decode-isodatetime." + "Test `icalendar--decode-isodatetime'." (should (equal (icalendar-test--format "20040917T050910-0200") "2004-09-17T03:09:10+0000")) (should (equal (icalendar-test--format "20040917T050910") diff --git a/test/lisp/calendar/solar-tests.el b/test/lisp/calendar/solar-tests.el index 337deb8ce9a..921be1d2d48 100644 --- a/test/lisp/calendar/solar-tests.el +++ b/test/lisp/calendar/solar-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (require 'solar) @@ -42,3 +44,5 @@ (should (< (abs (- sunset 17.72)) epsilon))))) (provide 'solar-tests) + +;;; solar-tests.el ends here diff --git a/test/lisp/calendar/todo-mode-tests.el b/test/lisp/calendar/todo-mode-tests.el index 6fa2b9d7c35..0538368fc82 100644 --- a/test/lisp/calendar/todo-mode-tests.el +++ b/test/lisp/calendar/todo-mode-tests.el @@ -35,7 +35,7 @@ "Todo Archive mode test file.") (defmacro with-todo-test (&rest body) - "Set up an isolated todo-mode test environment." + "Set up an isolated `todo-mode' test environment." (declare (debug (body))) `(let* ((todo-test-home (make-temp-file "todo-test-home-" t)) ;; Since we change HOME, clear this to avoid a conflict diff --git a/test/lisp/cedet/semantic-utest-c.el b/test/lisp/cedet/semantic-utest-c.el index d08c79cad3e..c5eb5b0ec06 100644 --- a/test/lisp/cedet/semantic-utest-c.el +++ b/test/lisp/cedet/semantic-utest-c.el @@ -60,7 +60,7 @@ (semantic-fetch-tags)))) (when (or (not tags-expected) (not tags-actual)) (message "Tried to find test files in: %s" semantic-utest-c-test-directory) - (error "Failed: Discovered no tags in test files or test file not found.")) + (error "Failed: Discovered no tags in test files or test file not found")) ;; Now that we have the tags, compare them for SPP accuracy. (dolist (tag tags-actual) diff --git a/test/lisp/cedet/semantic-utest-ia.el b/test/lisp/cedet/semantic-utest-ia.el index 122c431d472..6ea4ca1a16a 100644 --- a/test/lisp/cedet/semantic-utest-ia.el +++ b/test/lisp/cedet/semantic-utest-ia.el @@ -489,4 +489,4 @@ tag that contains point, and return that." (provide 'semantic-ia-utest) -;;; semantic-ia-utest.el ends here +;;; semantic-utest-ia.el ends here diff --git a/test/lisp/cedet/semantic-utest.el b/test/lisp/cedet/semantic-utest.el index 172ab62f895..3e4cfb0f0cb 100644 --- a/test/lisp/cedet/semantic-utest.el +++ b/test/lisp/cedet/semantic-utest.el @@ -29,6 +29,8 @@ (require 'cedet) (require 'semantic) +;;; Code: + (defvar cedet-utest-directory (let* ((C (file-name-directory (locate-library "cedet"))) (D (expand-file-name "../../test/manual/cedet/" C))) @@ -103,7 +105,7 @@ int calc_sv(int); (defvar semantic-utest-C-filename-h (concat (file-name-sans-extension semantic-utest-C-filename) ".h") - "Header file filename for C") + "Header file filename for C.") (defvar semantic-utest-C-name-contents @@ -424,8 +426,7 @@ class aClass { nil (overlay 135 262 "phptest.php")) ) - "Expected results from the PHP Unit test" - ) + "Expected results from the PHP Unit test.") ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; diff --git a/test/lisp/cedet/semantic/fw-tests.el b/test/lisp/cedet/semantic/fw-tests.el index 7b1cd21bd1b..6a5f3c85fc6 100644 --- a/test/lisp/cedet/semantic/fw-tests.el +++ b/test/lisp/cedet/semantic/fw-tests.el @@ -42,4 +42,4 @@ ;; retrieve cached data (should (equal (semantic-get-cache-data 'moose) data))))) -;;; gw-tests.el ends here +;;; fw-tests.el ends here diff --git a/test/lisp/comint-tests.el b/test/lisp/comint-tests.el index 8a9a41f452f..19d0cca88c8 100644 --- a/test/lisp/comint-tests.el +++ b/test/lisp/comint-tests.el @@ -1,4 +1,4 @@ -;;; comint-tests.el -*- lexical-binding:t -*- +;;; comint-tests.el --- Tests for comint.el -*- lexical-binding:t -*- ;; Copyright (C) 2010-2021 Free Software Foundation, Inc. @@ -94,4 +94,4 @@ password flow if it returns a nil value." ;; no-byte-compile: t ;; End: -;;; comint-testsuite.el ends here +;;; comint-tests.el ends here diff --git a/test/lisp/cus-edit-tests.el b/test/lisp/cus-edit-tests.el index 97b3349000c..f7d52834370 100644 --- a/test/lisp/cus-edit-tests.el +++ b/test/lisp/cus-edit-tests.el @@ -37,7 +37,7 @@ ;;;; showing/hiding obsolete options -(defgroup cus-edit-tests nil "test" +(defgroup cus-edit-tests nil "Test." :group 'test-group) (defcustom cus-edit-tests--obsolete-option-tag nil diff --git a/test/lisp/dabbrev-tests.el b/test/lisp/dabbrev-tests.el index 0b20dcf9213..e4b78373915 100644 --- a/test/lisp/dabbrev-tests.el +++ b/test/lisp/dabbrev-tests.el @@ -70,3 +70,5 @@ multiple expansions." ;; C-u C-u C-M-/ (execute-kbd-macro [21 21 201326639])) (should (string= (buffer-string) "abc\na"))))) + +;;; dabbrev-tests.el ends here diff --git a/test/lisp/descr-text-tests.el b/test/lisp/descr-text-tests.el index 2052dc0e38c..715fafa44c3 100644 --- a/test/lisp/descr-text-tests.el +++ b/test/lisp/descr-text-tests.el @@ -91,4 +91,4 @@ (provide 'descr-text-test) -;;; descr-text-test.el ends here +;;; descr-text-tests.el ends here diff --git a/test/lisp/dired-aux-tests.el b/test/lisp/dired-aux-tests.el index 7f1743f88d7..d5940ed8ca7 100644 --- a/test/lisp/dired-aux-tests.el +++ b/test/lisp/dired-aux-tests.el @@ -159,4 +159,4 @@ (dired-test--check-highlighting (nth 0 lines) '(8)))) (provide 'dired-aux-tests) -;; dired-aux-tests.el ends here +;;; dired-aux-tests.el ends here diff --git a/test/lisp/dired-tests.el b/test/lisp/dired-tests.el index aac78c64c69..83f7dc3cac7 100644 --- a/test/lisp/dired-tests.el +++ b/test/lisp/dired-tests.el @@ -518,4 +518,4 @@ (delete-directory testdir t))))) (provide 'dired-tests) -;; dired-tests.el ends here +;;; dired-tests.el ends here diff --git a/test/lisp/dired-x-tests.el b/test/lisp/dired-x-tests.el index 003923d60fa..d00815e543c 100644 --- a/test/lisp/dired-x-tests.el +++ b/test/lisp/dired-x-tests.el @@ -63,4 +63,4 @@ nil)))) (provide 'dired-x-tests) -;; dired-x-tests.el ends here +;;; dired-x-tests.el ends here diff --git a/test/lisp/electric-tests.el b/test/lisp/electric-tests.el index 46bcbfce307..4e7cbf5419b 100644 --- a/test/lisp/electric-tests.el +++ b/test/lisp/electric-tests.el @@ -871,7 +871,7 @@ baz\"\"" (local-set-key (vector key) 'self-insert-command))) (defun electric-layout-for-c-style-du-jour (inserted) - "A function to use in `electric-layout-rules'" + "A function to use in `electric-layout-rules'." (when (memq inserted '(?\{ ?\})) (save-excursion (backward-char 2) (c-point-syntax) (forward-char) ; silly, but needed diff --git a/test/lisp/emacs-lisp/bytecomp-tests.el b/test/lisp/emacs-lisp/bytecomp-tests.el index 14df39bfd77..448c7be6219 100644 --- a/test/lisp/emacs-lisp/bytecomp-tests.el +++ b/test/lisp/emacs-lisp/bytecomp-tests.el @@ -1,4 +1,4 @@ -;;; bytecomp-tests.el -*- lexical-binding:t -*- +;;; bytecomp-tests.el --- Tests for bytecomp.el -*- lexical-binding:t -*- ;; Copyright (C) 2008-2021 Free Software Foundation, Inc. @@ -1498,4 +1498,4 @@ EXPECTED-POINT BINDINGS (MODES \\='\\='(ruby-mode js-mode python-mode)) \ ;; End: (provide 'bytecomp-tests) -;; bytecomp-tests.el ends here. +;;; bytecomp-tests.el ends here diff --git a/test/lisp/emacs-lisp/cconv-tests.el b/test/lisp/emacs-lisp/cconv-tests.el index 5aeed0cc155..4290571735e 100644 --- a/test/lisp/emacs-lisp/cconv-tests.el +++ b/test/lisp/emacs-lisp/cconv-tests.el @@ -1,4 +1,4 @@ -;;; cconv-tests.el -*- lexical-binding: t -*- +;;; cconv-tests.el --- Tests for cconv.el -*- lexical-binding: t -*- ;; Copyright (C) 2018-2021 Free Software Foundation, Inc. @@ -19,6 +19,8 @@ ;;; Commentary: +;;; Code: + (require 'ert) (require 'cl-lib) @@ -204,4 +206,4 @@ 42))) (provide 'cconv-tests) -;; cconv-tests.el ends here. +;;; cconv-tests.el ends here diff --git a/test/lisp/emacs-lisp/eieio-tests/eieio-test-methodinvoke.el b/test/lisp/emacs-lisp/eieio-tests/eieio-test-methodinvoke.el index 9f9bb73133c..d1da066dc45 100644 --- a/test/lisp/emacs-lisp/eieio-tests/eieio-test-methodinvoke.el +++ b/test/lisp/emacs-lisp/eieio-tests/eieio-test-methodinvoke.el @@ -22,22 +22,22 @@ ;;; Commentary: ;; -;; Test method invocation order. From the common lisp reference -;; manual: +;; Test method invocation order. From the Common Lisp Reference +;; Manual: ;; ;; QUOTE: ;; - All the :before methods are called, in most-specific-first ;; order. Their values are ignored. An error is signaled if ;; call-next-method is used in a :before method. ;; -;; - The most specific primary method is called. Inside the body of a +;; - The most specific primary method is called. Inside the body of a ;; primary method, call-next-method may be used to call the next -;; most specific primary method. When that method returns, the +;; most specific primary method. When that method returns, the ;; previous primary method can execute more code, perhaps based on -;; the returned value or values. The generic function no-next-method +;; the returned value or values. The generic function no-next-method ;; is invoked if call-next-method is used and there are no more -;; applicable primary methods. The function next-method-p may be -;; used to determine whether a next method exists. If +;; applicable primary methods. The function next-method-p may be +;; used to determine whether a next method exists. If ;; call-next-method is not used, only the most specific primary ;; method is called. ;; @@ -46,12 +46,14 @@ ;; call-next-method is used in a :after method. ;; ;; -;; Also test behavior of `call-next-method'. From clos.org: +;; Also test behavior of `call-next-method'. From clos.org: ;; ;; QUOTE: ;; When call-next-method is called with no arguments, it passes the ;; current method's original arguments to the next method. +;;; Code: + (require 'eieio) (require 'ert) @@ -403,3 +405,5 @@ (should (equal (eieio-test--1 (make-instance 'CNM-2) 5) '("CNM-1-1" "CNM-1-2" "CNM-0" 7 5))) (should (equal (eieio-test--1 'CNM-2 6) '("subclass CNM-1-2" CNM-2 6)))) + +;;; eieio-test-methodinvoke.el ends here diff --git a/test/lisp/emacs-lisp/eieio-tests/eieio-test-persist.el b/test/lisp/emacs-lisp/eieio-tests/eieio-test-persist.el index ddbef02c35a..fd044ff3734 100644 --- a/test/lisp/emacs-lisp/eieio-tests/eieio-test-persist.el +++ b/test/lisp/emacs-lisp/eieio-tests/eieio-test-persist.el @@ -165,9 +165,9 @@ Assume SLOTVALUE is a symbol of some sort." ((slot1 :initarg :slot1 :initform 1) (slot2 :initform 2)) - "Class for testing persistent saving of an object that isn't -persistent. This class is instead used as a slot value in a -persistent class.") + "Class for testing persistent saving of an object that isn't persistent. +This class is instead used as a slot value in a persistent +class.") (defclass persistent-with-objs-slot (eieio-persistent) ((pnp :initarg :pnp diff --git a/test/lisp/emacs-lisp/eieio-tests/eieio-tests.el b/test/lisp/emacs-lisp/eieio-tests/eieio-tests.el index 3ec42343443..9eb7fb02230 100644 --- a/test/lisp/emacs-lisp/eieio-tests/eieio-tests.el +++ b/test/lisp/emacs-lisp/eieio-tests/eieio-tests.el @@ -48,13 +48,13 @@ :type (or null class-a) :documentation "Test self referencing types.") ) - "Class A") + "Class A.") (defclass class-b () ((land :initform "Sc" :type string :documentation "Detail about land.")) - "Class B") + "Class B.") (defclass class-ab (class-a class-b) ((amphibian :initform "frog" @@ -160,7 +160,7 @@ ;; error (should-error (abstract-class))) -(defgeneric generic1 () "First generic function") +(defgeneric generic1 () "First generic function.") (ert-deftest eieio-test-03-generics () (defun anormalfunction () "A plain function for error testing." nil) @@ -901,12 +901,12 @@ Subclasses to override slot attributes.") (defclass opt-test1 () () - "Abstract base class" + "Abstract base class." :abstract t) (defclass opt-test2 (opt-test1) () - "Instantiable child") + "Instantiable child.") (ert-deftest eieio-test-36-build-class-alist () (should (= (length (eieio-build-class-alist 'opt-test1 nil)) 2)) diff --git a/test/lisp/emacs-lisp/faceup-resources/faceup-test-this-file-directory.el b/test/lisp/emacs-lisp/faceup-resources/faceup-test-this-file-directory.el index 3303e7b178d..9fe5fe9218d 100644 --- a/test/lisp/emacs-lisp/faceup-resources/faceup-test-this-file-directory.el +++ b/test/lisp/emacs-lisp/faceup-resources/faceup-test-this-file-directory.el @@ -22,7 +22,7 @@ ;;; Commentary: -;; Support file for `faceup-test-basics.el'. This file is used to test +;; Support file for `faceup-test-basics.el'. This file is used to test ;; `faceup-this-file-directory' in various contexts. ;;; Code: diff --git a/test/lisp/emacs-lisp/generator-tests.el b/test/lisp/emacs-lisp/generator-tests.el index a1b9f64fdb1..c81d3d09e7d 100644 --- a/test/lisp/emacs-lisp/generator-tests.el +++ b/test/lisp/emacs-lisp/generator-tests.el @@ -271,7 +271,7 @@ identical output." (unwind-protect (progn (iter-yield 1) - (error "test") + (error "Test") (iter-yield 2)) (cl-incf nr-unwound)))))) (should (equal (iter-next iter) 1)) diff --git a/test/lisp/emacs-lisp/let-alist-tests.el b/test/lisp/emacs-lisp/let-alist-tests.el index d856696da24..88e689c80b8 100644 --- a/test/lisp/emacs-lisp/let-alist-tests.el +++ b/test/lisp/emacs-lisp/let-alist-tests.el @@ -100,4 +100,4 @@ See Bug#24641." `[,(+ .a) ,(+ .a .b .b)]) [1 5]))) -;;; let-alist.el ends here +;;; let-alist-tests.el ends here diff --git a/test/lisp/emacs-lisp/memory-report-tests.el b/test/lisp/emacs-lisp/memory-report-tests.el index e352dd165f3..d37f09b34f2 100644 --- a/test/lisp/emacs-lisp/memory-report-tests.el +++ b/test/lisp/emacs-lisp/memory-report-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (require 'memory-report) diff --git a/test/lisp/emacs-lisp/nadvice-tests.el b/test/lisp/emacs-lisp/nadvice-tests.el index 358d9025ad5..ee33bb0fa40 100644 --- a/test/lisp/emacs-lisp/nadvice-tests.el +++ b/test/lisp/emacs-lisp/nadvice-tests.el @@ -208,4 +208,4 @@ function being an around advice." ;; no-byte-compile: t ;; End: -;;; advice-tests.el ends here. +;;; nadvice-tests.el ends here diff --git a/test/lisp/emacs-lisp/package-resources/macro-problem-package-1.0/macro-aux.el b/test/lisp/emacs-lisp/package-resources/macro-problem-package-1.0/macro-aux.el index f43232224af..ad20a3507a6 100644 --- a/test/lisp/emacs-lisp/package-resources/macro-problem-package-1.0/macro-aux.el +++ b/test/lisp/emacs-lisp/package-resources/macro-problem-package-1.0/macro-aux.el @@ -5,7 +5,7 @@ ;;; Code: (defun macro-aux-1 ( &rest forms) - "Description" + "Description." `(progn ,@forms)) (provide 'macro-aux) diff --git a/test/lisp/emacs-lisp/package-resources/macro-problem-package-1.0/macro-problem.el b/test/lisp/emacs-lisp/package-resources/macro-problem-package-1.0/macro-problem.el index 0533b1bd9c4..6e5e54e54fd 100644 --- a/test/lisp/emacs-lisp/package-resources/macro-problem-package-1.0/macro-problem.el +++ b/test/lisp/emacs-lisp/package-resources/macro-problem-package-1.0/macro-problem.el @@ -9,11 +9,11 @@ (require 'macro-aux) (defmacro macro-problem-1 ( &rest forms) - "Description" + "Description." `(progn ,@forms)) (defun macro-problem-func () - "" + "Description." (macro-problem-1 'a 'b) (macro-aux-1 'a 'b)) diff --git a/test/lisp/emacs-lisp/package-resources/macro-problem-package-2.0/macro-aux.el b/test/lisp/emacs-lisp/package-resources/macro-problem-package-2.0/macro-aux.el index 6a55a40e3b4..814d77183ab 100644 --- a/test/lisp/emacs-lisp/package-resources/macro-problem-package-2.0/macro-aux.el +++ b/test/lisp/emacs-lisp/package-resources/macro-problem-package-2.0/macro-aux.el @@ -5,11 +5,11 @@ ;;; Code: (defmacro macro-aux-1 ( &rest forms) - "Description" + "Description." `(progn ,@forms)) (defmacro macro-aux-3 ( &rest _) - "Description" + "Description." 90) (provide 'macro-aux) diff --git a/test/lisp/emacs-lisp/package-resources/macro-problem-package-2.0/macro-problem.el b/test/lisp/emacs-lisp/package-resources/macro-problem-package-2.0/macro-problem.el index cad4ed93f19..aef5eda7c6c 100644 --- a/test/lisp/emacs-lisp/package-resources/macro-problem-package-2.0/macro-problem.el +++ b/test/lisp/emacs-lisp/package-resources/macro-problem-package-2.0/macro-problem.el @@ -9,21 +9,21 @@ (require 'macro-aux) (defmacro macro-problem-1 ( &rest forms) - "Description" + "Description." `(progn ,(cadr (car forms)))) (defun macro-problem-func () - "" + "Description." (list (macro-problem-1 '1 'b) (macro-aux-1 'a 'b))) (defmacro macro-problem-3 (&rest _) - "Description" + "Description." 10) (defun macro-problem-10-and-90 () - "" + "Description." (list (macro-problem-3 haha) (macro-aux-3 hehe))) (provide 'macro-problem) diff --git a/test/lisp/emacs-lisp/package-resources/newer-versions/simple-single-1.4.el b/test/lisp/emacs-lisp/package-resources/newer-versions/simple-single-1.4.el index 301993deb30..be6bedf8a1c 100644 --- a/test/lisp/emacs-lisp/package-resources/newer-versions/simple-single-1.4.el +++ b/test/lisp/emacs-lisp/package-resources/newer-versions/simple-single-1.4.el @@ -7,14 +7,14 @@ ;;; Commentary: ;; This package provides a minor mode to frobnicate and/or bifurcate -;; any flanges you desire. To activate it, type "C-M-r M-3 butterfly" +;; any flanges you desire. To activate it, type "C-M-r M-3 butterfly" ;; and all your dreams will come true. ;; ;; This is a new, updated version. ;;; Code: -(defgroup simple-single nil "Simply a file" +(defgroup simple-single nil "Simply a file." :group 'lisp) (defcustom simple-single-super-sunday nil @@ -29,7 +29,7 @@ Default changed to nil." ;;;###autoload (define-minor-mode simple-single-mode - "It does good things to stuff") + "It does good things to stuff.") (provide 'simple-single) diff --git a/test/lisp/emacs-lisp/package-resources/signed/signed-bad-1.0.el b/test/lisp/emacs-lisp/package-resources/signed/signed-bad-1.0.el index ff070c6526f..781077251e9 100644 --- a/test/lisp/emacs-lisp/package-resources/signed/signed-bad-1.0.el +++ b/test/lisp/emacs-lisp/package-resources/signed/signed-bad-1.0.el @@ -8,12 +8,12 @@ ;;; Commentary: ;; This package provides a minor mode to frobnicate and/or bifurcate -;; any flanges you desire. To activate it, type "C-M-r M-3 butterfly" +;; any flanges you desire. To activate it, type "C-M-r M-3 butterfly" ;; and all your dreams will come true. ;;; Code: -(defgroup signed-bad nil "Simply a file" +(defgroup signed-bad nil "Simply a file." :group 'lisp) (defcustom signed-bad-super-sunday t @@ -26,7 +26,7 @@ ;;;###autoload (define-minor-mode signed-bad-mode - "It does good things to stuff") + "It does good things to stuff.") (provide 'signed-bad) diff --git a/test/lisp/emacs-lisp/package-resources/signed/signed-good-1.0.el b/test/lisp/emacs-lisp/package-resources/signed/signed-good-1.0.el index 60b1b8663d9..8a408c1f301 100644 --- a/test/lisp/emacs-lisp/package-resources/signed/signed-good-1.0.el +++ b/test/lisp/emacs-lisp/package-resources/signed/signed-good-1.0.el @@ -8,12 +8,12 @@ ;;; Commentary: ;; This package provides a minor mode to frobnicate and/or bifurcate -;; any flanges you desire. To activate it, type "C-M-r M-3 butterfly" +;; any flanges you desire. To activate it, type "C-M-r M-3 butterfly" ;; and all your dreams will come true. ;;; Code: -(defgroup signed-good nil "Simply a file" +(defgroup signed-good nil "Simply a file." :group 'lisp) (defcustom signed-good-super-sunday t @@ -26,7 +26,7 @@ ;;;###autoload (define-minor-mode signed-good-mode - "It does good things to stuff") + "It does good things to stuff.") (provide 'signed-good) diff --git a/test/lisp/emacs-lisp/package-resources/simple-depend-1.0.el b/test/lisp/emacs-lisp/package-resources/simple-depend-1.0.el index cb003905bb5..f1ee8627610 100644 --- a/test/lisp/emacs-lisp/package-resources/simple-depend-1.0.el +++ b/test/lisp/emacs-lisp/package-resources/simple-depend-1.0.el @@ -12,6 +12,6 @@ ;;; Code: (defvar simple-depend "Value" - "Some trivial code") + "Some trivial code.") ;;; simple-depend.el ends here diff --git a/test/lisp/emacs-lisp/package-resources/simple-single-1.3.el b/test/lisp/emacs-lisp/package-resources/simple-single-1.3.el index 9c3f427ff48..459801d78cf 100644 --- a/test/lisp/emacs-lisp/package-resources/simple-single-1.3.el +++ b/test/lisp/emacs-lisp/package-resources/simple-single-1.3.el @@ -8,12 +8,12 @@ ;;; Commentary: ;; This package provides a minor mode to frobnicate and/or bifurcate -;; any flanges you desire. To activate it, type "C-M-r M-3 butterfly" +;; any flanges you desire. To activate it, type "C-M-r M-3 butterfly" ;; and all your dreams will come true. ;;; Code: -(defgroup simple-single nil "Simply a file" +(defgroup simple-single nil "Simply a file." :group 'lisp) (defcustom simple-single-super-sunday t @@ -26,7 +26,7 @@ ;;;###autoload (define-minor-mode simple-single-mode - "It does good things to stuff") + "It does good things to stuff.") (provide 'simple-single) diff --git a/test/lisp/emacs-lisp/package-resources/simple-two-depend-1.1.el b/test/lisp/emacs-lisp/package-resources/simple-two-depend-1.1.el index a0a9607350a..8de6141d67a 100644 --- a/test/lisp/emacs-lisp/package-resources/simple-two-depend-1.1.el +++ b/test/lisp/emacs-lisp/package-resources/simple-two-depend-1.1.el @@ -12,6 +12,6 @@ ;;; Code: (defvar simple-two-depend "Value" - "Some trivial code") + "Some trivial code.") ;;; simple-two-depend.el ends here diff --git a/test/lisp/emacs-lisp/package-tests.el b/test/lisp/emacs-lisp/package-tests.el index 77bc8117cf2..1fd93bc1be7 100644 --- a/test/lisp/emacs-lisp/package-tests.el +++ b/test/lisp/emacs-lisp/package-tests.el @@ -180,7 +180,7 @@ (replace-regexp-in-string "-pkg\\.el\\'" "" (package--description-file dir))) (defun package-test-suffix-matches (base suffix-list) - "Return file names matching BASE concatenated with each item in SUFFIX-LIST" + "Return file names matching BASE concatenated with each item in SUFFIX-LIST." (mapcan (lambda (item) (file-expand-wildcards (concat base item))) suffix-list)) diff --git a/test/lisp/emacs-lisp/regexp-opt-tests.el b/test/lisp/emacs-lisp/regexp-opt-tests.el index 940feb5e828..65494e20df6 100644 --- a/test/lisp/emacs-lisp/regexp-opt-tests.el +++ b/test/lisp/emacs-lisp/regexp-opt-tests.el @@ -66,4 +66,4 @@ (should (equal (regexp-opt-charset '()) regexp-unmatchable))) -;;; regexp-tests.el ends here. +;;; regexp-opt-tests.el ends here diff --git a/test/lisp/emacs-lisp/rx-tests.el b/test/lisp/emacs-lisp/rx-tests.el index 4828df0de92..3bc35feb6dd 100644 --- a/test/lisp/emacs-lisp/rx-tests.el +++ b/test/lisp/emacs-lisp/rx-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (require 'rx) @@ -583,3 +585,5 @@ "\\(?3:.+$\\)"))) (provide 'rx-tests) + +;;; rx-tests.el ends here diff --git a/test/lisp/emacs-lisp/shortdoc-tests.el b/test/lisp/emacs-lisp/shortdoc-tests.el index 3bb3185649b..cfb0b4244bc 100644 --- a/test/lisp/emacs-lisp/shortdoc-tests.el +++ b/test/lisp/emacs-lisp/shortdoc-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (require 'shortdoc) @@ -43,3 +45,5 @@ (setq props (cddr props)))))))) (provide 'shortdoc-tests) + +;;; shortdoc-tests.el ends here diff --git a/test/lisp/emacs-lisp/testcover-resources/testcases.el b/test/lisp/emacs-lisp/testcover-resources/testcases.el index 7ced257c6f9..29094526d7e 100644 --- a/test/lisp/emacs-lisp/testcover-resources/testcases.el +++ b/test/lisp/emacs-lisp/testcover-resources/testcases.el @@ -77,12 +77,12 @@ "Testcover doesn't prevent testing of defcustom values." ;; ==== (defgroup testcover-testcase nil - "Test case for testcover" + "Test case for testcover." :group 'lisp :prefix "testcover-testcase-" :version "26.0") (defcustom testcover-testcase-flag t - "Test value used by testcover-tests.el" + "Test value used by testcover-tests.el." :type 'boolean :group 'testcover-testcase) (defun testcover-testcase-get-flag () @@ -111,7 +111,7 @@ "Wrapping a form with noreturn prevents splotching." ;; ==== (defun testcover-testcase-cancel (spacecraft) - (error "no destination for %s" spacecraft)) + (error "No destination for %s" spacecraft)) (defun testcover-testcase-launch (spacecraft planet) (if (null planet) (noreturn (testcover-testcase-cancel spacecraft%%%)) @@ -220,7 +220,7 @@ (defun testcover-testcase-cc (arg) (condition-case nil (if (null arg%%%)%%% - (error "foo") + (error "Foo") "0")!!! (error nil))) (should-not (testcover-testcase-cc nil)) @@ -510,4 +510,4 @@ regarding the odd-looking coverage result for the quoted form." (testcover-testcase-cyc2 1 2) (testcover-testcase-cyc2 1 4) -;; testcases.el ends here. +;;; testcases.el ends here diff --git a/test/lisp/emacs-lisp/unsafep-tests.el b/test/lisp/emacs-lisp/unsafep-tests.el index b2a48d80675..f0d9b032438 100644 --- a/test/lisp/emacs-lisp/unsafep-tests.el +++ b/test/lisp/emacs-lisp/unsafep-tests.el @@ -105,7 +105,7 @@ . (variable (x))) ( (let (1) 2) . (variable 1)) - ( (error "asdf") + ( (error "Asdf") . #'error) ( (signal 'error "asdf") . #'signal) diff --git a/test/lisp/erc/erc-tests.el b/test/lisp/erc/erc-tests.el index 22f62a35c7e..6ed26f68289 100644 --- a/test/lisp/erc/erc-tests.el +++ b/test/lisp/erc/erc-tests.el @@ -227,3 +227,5 @@ (when noninteractive (kill-buffer "*erc-protocol*") (should-not erc-debug-irc-protocol))) + +;;; erc-tests.el ends here diff --git a/test/lisp/erc/erc-track-tests.el b/test/lisp/erc/erc-track-tests.el index 0ce93bd45c6..b2687a96ab3 100644 --- a/test/lisp/erc/erc-track-tests.el +++ b/test/lisp/erc/erc-track-tests.el @@ -119,3 +119,5 @@ '(bold erc-current-nick-face) str1) (should (erc-faces-in str0)) (should (erc-faces-in str1)) )) + +;;; erc-track-tests.el ends here diff --git a/test/lisp/eshell/eshell-tests.el b/test/lisp/eshell/eshell-tests.el index 4f0cc9b6785..a460f45bf13 100644 --- a/test/lisp/eshell/eshell-tests.el +++ b/test/lisp/eshell/eshell-tests.el @@ -262,4 +262,4 @@ chars" (provide 'eshell-tests) -;;; tests/eshell-tests.el ends here +;;; eshell-tests.el ends here diff --git a/test/lisp/faces-resources/faces-test-dark-theme.el b/test/lisp/faces-resources/faces-test-dark-theme.el index f3ef6b67fa7..7e8871ec10a 100644 --- a/test/lisp/faces-resources/faces-test-dark-theme.el +++ b/test/lisp/faces-resources/faces-test-dark-theme.el @@ -22,7 +22,7 @@ ;;; Code: (deftheme faces-test-dark - "") + "Dark test theme.") (custom-theme-set-faces 'faces-test-dark diff --git a/test/lisp/faces-resources/faces-test-light-theme.el b/test/lisp/faces-resources/faces-test-light-theme.el index 390b8461644..70a75017614 100644 --- a/test/lisp/faces-resources/faces-test-light-theme.el +++ b/test/lisp/faces-resources/faces-test-light-theme.el @@ -22,7 +22,7 @@ ;;; Code: (deftheme faces-test-light - "") + "Light test theme.") (custom-theme-set-faces 'faces-test-light diff --git a/test/lisp/faces-tests.el b/test/lisp/faces-tests.el index c0db9c9de17..fe5f3ec95f8 100644 --- a/test/lisp/faces-tests.el +++ b/test/lisp/faces-tests.el @@ -25,7 +25,7 @@ (require 'ert) (require 'ert-x) -(defgroup faces--test nil "" +(defgroup faces--test nil "Group to test faces." :group 'faces--test) (defface faces--test1 diff --git a/test/lisp/gnus/gnus-search-tests.el b/test/lisp/gnus/gnus-search-tests.el index 6148da65621..9f012d4e888 100644 --- a/test/lisp/gnus/gnus-search-tests.el +++ b/test/lisp/gnus/gnus-search-tests.el @@ -97,4 +97,4 @@ "more bits")))) (provide 'gnus-search-tests) -;;; search-tests.el ends here +;;; gnus-search-tests.el ends here diff --git a/test/lisp/gnus/gnus-util-tests.el b/test/lisp/gnus/gnus-util-tests.el index f8d30f6373e..60a9cde0e7f 100644 --- a/test/lisp/gnus/gnus-util-tests.el +++ b/test/lisp/gnus/gnus-util-tests.el @@ -132,4 +132,4 @@ (should (equal '("1") (gnus-setdiff '(2 "1" 2) '(2)))) (should (equal '("1" "1") (gnus-setdiff '(2 "1" 2 "1") '(2))))) -;;; gnustest-gnus-util.el ends here +;;; gnus-util-tests.el ends here diff --git a/test/lisp/gnus/message-tests.el b/test/lisp/gnus/message-tests.el index b4f2b7f675d..0f42f62f386 100644 --- a/test/lisp/gnus/message-tests.el +++ b/test/lisp/gnus/message-tests.el @@ -185,4 +185,4 @@ Hello. (provide 'message-mode-tests) -;;; message-mode-tests.el ends here +;;; message-tests.el ends here diff --git a/test/lisp/htmlfontify-tests.el b/test/lisp/htmlfontify-tests.el index 879131cae32..15798319a13 100644 --- a/test/lisp/htmlfontify-tests.el +++ b/test/lisp/htmlfontify-tests.el @@ -43,4 +43,4 @@ available (Bug#25468)." 0))) (provide 'htmlfontify-tests) -;; htmlfontify-tests.el ends here +;;; htmlfontify-tests.el ends here diff --git a/test/lisp/ibuffer-tests.el b/test/lisp/ibuffer-tests.el index a51079180a5..9b0327b0ef0 100644 --- a/test/lisp/ibuffer-tests.el +++ b/test/lisp/ibuffer-tests.el @@ -826,4 +826,4 @@ (should (equal (ibuffer-unary-operand '(not . a)) 'a))) (provide 'ibuffer-tests) -;; ibuffer-tests.el ends here +;;; ibuffer-tests.el ends here diff --git a/test/lisp/info-xref-tests.el b/test/lisp/info-xref-tests.el index ecba86146f1..0b8091f17af 100644 --- a/test/lisp/info-xref-tests.el +++ b/test/lisp/info-xref-tests.el @@ -161,4 +161,4 @@ text. (line-end-position))))))) -;;; info-xref.el ends here +;;; info-xref-tests.el ends here diff --git a/test/lisp/international/ccl-tests.el b/test/lisp/international/ccl-tests.el index 0f765e4ff88..f3da2d88732 100644 --- a/test/lisp/international/ccl-tests.el +++ b/test/lisp/international/ccl-tests.el @@ -246,3 +246,5 @@ At EOF: (registers [17 0 0 0 0 0 0 0])) (ccl-execute compiled registers) (should (equal registers [2 16 0 0 0 0 0 1]))))) + +;;; ccl-tests.el ends here diff --git a/test/lisp/jit-lock-tests.el b/test/lisp/jit-lock-tests.el index 121966b2b77..a54aad8165c 100644 --- a/test/lisp/jit-lock-tests.el +++ b/test/lisp/jit-lock-tests.el @@ -58,3 +58,5 @@ (with-silent-modifications (put-text-property (point-min) (point-max) 'fontified t)) (jit-lock-fontify-now (point-min) (point-max)))) + +;;; jit-lock-tests.el ends here diff --git a/test/lisp/kmacro-tests.el b/test/lisp/kmacro-tests.el index 8736f7fd2dc..ecd3d5fc22b 100644 --- a/test/lisp/kmacro-tests.el +++ b/test/lisp/kmacro-tests.el @@ -834,7 +834,7 @@ and `read-event' and `read-key-sequence' set up to return items from EVENTS and SEQUENCES respectively. SEQUENCES may be nil, but EVENTS should not be. EVENTS should be a list of symbols bound in `kmacro-step-edit-map' or `query-replace' map, and this function -will do the keymap lookup for you. SEQUENCES should contain +will do the keymap lookup for you. SEQUENCES should contain return values for `read-key-sequence'. Before running the macro, the current buffer will be erased. diff --git a/test/lisp/mail/rmail-tests.el b/test/lisp/mail/rmail-tests.el index f533401496b..826a90455fb 100644 --- a/test/lisp/mail/rmail-tests.el +++ b/test/lisp/mail/rmail-tests.el @@ -32,4 +32,4 @@ 'rmail-edit-current-message)))) (provide 'rmail-tests) -;; rmail-tests.el ends here +;;; rmail-tests.el ends here diff --git a/test/lisp/mail/rmailmm-tests.el b/test/lisp/mail/rmailmm-tests.el index a022008b534..d7b3775d6d0 100644 --- a/test/lisp/mail/rmailmm-tests.el +++ b/test/lisp/mail/rmailmm-tests.el @@ -114,4 +114,4 @@ This is the epilogue. It is also to be ignored.")) (provide 'rmailmm-tests) -;; rmailmm-tests.el ends here +;;; rmailmm-tests.el ends here diff --git a/test/lisp/mail/uudecode-tests.el b/test/lisp/mail/uudecode-tests.el index 6ff767562e3..981ce1c4ae0 100644 --- a/test/lisp/mail/uudecode-tests.el +++ b/test/lisp/mail/uudecode-tests.el @@ -35,11 +35,11 @@ (defvar uudecode-tests-encoded-str (uudecode-tests-read-file (ert-resource-file "uuencoded.txt")) - "Uuencoded data for bookmark-tests.el + "Uuencoded data for bookmark-tests.el. Same as `uudecode-tests-decoded-str' but uuencoded.") (defvar uudecode-tests-decoded-str (uudecode-tests-read-file (ert-resource-file "uudecoded.txt")) - "Plain text data for bookmark-tests.el + "Plain text data for bookmark-tests.el. Same as `uudecode-tests-encoded-str' but plain text.") (ert-deftest uudecode-tests-decode-region-internal () diff --git a/test/lisp/net/shr-tests.el b/test/lisp/net/shr-tests.el index ed532af657a..bfb83f25184 100644 --- a/test/lisp/net/shr-tests.el +++ b/test/lisp/net/shr-tests.el @@ -67,4 +67,4 @@ (require 'shr) -;;; shr-stream-tests.el ends here +;;; shr-tests.el ends here diff --git a/test/lisp/net/socks-tests.el b/test/lisp/net/socks-tests.el index c0f90bc2d47..9079c1bef2a 100644 --- a/test/lisp/net/socks-tests.el +++ b/test/lisp/net/socks-tests.el @@ -128,7 +128,7 @@ (defvar socks-tests-canned-server-patterns nil "Alist containing request/response cons pairs to be tried in order. -Vectors must match verbatim. Strings are considered regex patterns.") +Vectors must match verbatim. Strings are considered regex patterns.") (defun socks-tests-canned-server-create () "Create and return a fake SOCKS server." diff --git a/test/lisp/net/tramp-tests.el b/test/lisp/net/tramp-tests.el index 26a3ac7e964..55396c50797 100644 --- a/test/lisp/net/tramp-tests.el +++ b/test/lisp/net/tramp-tests.el @@ -6071,7 +6071,7 @@ This requires restrictions of file name syntax." 'tramp-ftp-file-name-handler)) (defun tramp--test-crypt-p () - "Check, whether the remote directory is crypted" + "Check, whether the remote directory is crypted." (tramp-crypt-file-name-p tramp-test-temporary-file-directory)) (defun tramp--test-docker-p () diff --git a/test/lisp/newcomment-tests.el b/test/lisp/newcomment-tests.el index 5485673b72d..65690e593db 100644 --- a/test/lisp/newcomment-tests.el +++ b/test/lisp/newcomment-tests.el @@ -1,4 +1,4 @@ -;;; newcomment-tests.el -*- lexical-binding:t -*- +;;; newcomment-tests.el --- Tests for newcomment.el -*- lexical-binding:t -*- ;; Copyright (C) 2021 Free Software Foundation, Inc. @@ -36,4 +36,4 @@ (uncomment-region (point-min) (point-max)) (buffer-string)))))) -;;; newcomment-testsuite.el ends here +;;; newcomment-tests.el ends here diff --git a/test/lisp/org/org-tests.el b/test/lisp/org/org-tests.el index c1985a46a40..e53b0384081 100644 --- a/test/lisp/org/org-tests.el +++ b/test/lisp/org/org-tests.el @@ -29,3 +29,5 @@ Ref ." (should (require 'org-version nil t)) (should (equal (version-to-list (org-release)) (cdr (assq 'org package--builtin-versions))))) + +;;; org-tests.el ends here diff --git a/test/lisp/play/cookie1-tests.el b/test/lisp/play/cookie1-tests.el index 75dea4e5ef0..2dd73d18028 100644 --- a/test/lisp/play/cookie1-tests.el +++ b/test/lisp/play/cookie1-tests.el @@ -37,4 +37,4 @@ (should (= (length (cookie-apropos "false" fortune-file)) 1)))) (provide 'fortune-tests) -;;; fortune-tests.el ends here +;;; cookie1-tests.el ends here diff --git a/test/lisp/progmodes/elisp-mode-tests.el b/test/lisp/progmodes/elisp-mode-tests.el index 60946c2f446..ba349237cb7 100644 --- a/test/lisp/progmodes/elisp-mode-tests.el +++ b/test/lisp/progmodes/elisp-mode-tests.el @@ -429,7 +429,7 @@ to (xref-elisp-test-descr-to-target xref)." slot-1) (cl-defgeneric xref-elisp-generic-no-methods (arg1 arg2) - "doc string generic no-methods" + "Doc string generic no-methods." ;; No default implementation, no methods, but fboundp is true for ;; this symbol; it calls cl-no-applicable-method ) @@ -440,44 +440,44 @@ to (xref-elisp-test-descr-to-target xref)." ;; ‘this’. It passes in interactive tests, so I haven't been able to ;; track down the problem. (cl-defmethod xref-elisp-generic-no-default ((this xref-elisp-root-type) arg2) - "doc string generic no-default xref-elisp-root-type" + "Doc string generic no-default xref-elisp-root-type." "non-default for no-default") ;; defgeneric after defmethod in file to ensure the fallback search ;; method of just looking for the function name will fail. (cl-defgeneric xref-elisp-generic-no-default (arg1 arg2) - "doc string generic no-default generic" + "Doc string generic no-default generic." ;; No default implementation; this function calls the cl-generic ;; dispatching code. ) (cl-defgeneric xref-elisp-generic-co-located-default (arg1 arg2) - "doc string generic co-located-default" + "Doc string generic co-located-default." "co-located default") (cl-defmethod xref-elisp-generic-co-located-default ((this xref-elisp-root-type) arg2) - "doc string generic co-located-default xref-elisp-root-type" + "Doc string generic co-located-default xref-elisp-root-type." "non-default for co-located-default") (cl-defgeneric xref-elisp-generic-separate-default (arg1 arg2) - "doc string generic separate-default" + "Doc string generic separate-default." ;; default implementation provided separately ) (cl-defmethod xref-elisp-generic-separate-default (arg1 arg2) - "doc string generic separate-default default" + "Doc string generic separate-default default." "separate default") (cl-defmethod xref-elisp-generic-separate-default ((this xref-elisp-root-type) arg2) - "doc string generic separate-default xref-elisp-root-type" + "Doc string generic separate-default xref-elisp-root-type." "non-default for separate-default") (cl-defmethod xref-elisp-generic-implicit-generic (arg1 arg2) - "doc string generic implicit-generic default" + "Doc string generic implicit-generic default." "default for implicit generic") (cl-defmethod xref-elisp-generic-implicit-generic ((this xref-elisp-root-type) arg2) - "doc string generic implicit-generic xref-elisp-root-type" + "Doc string generic implicit-generic xref-elisp-root-type." "non-default for implicit generic") @@ -623,35 +623,35 @@ to (xref-elisp-test-descr-to-target xref)." (declare-function xref-elisp-overloadable-no-default-default "elisp-mode-tests") (define-overloadable-function xref-elisp-overloadable-no-methods () - "doc string overloadable no-methods") + "Doc string overloadable no-methods.") (define-overloadable-function xref-elisp-overloadable-no-default () - "doc string overloadable no-default") + "Doc string overloadable no-default.") (define-mode-local-override xref-elisp-overloadable-no-default c-mode (_start _end &optional _nonterminal _depth _returnonerror) - "doc string overloadable no-default c-mode." + "Doc string overloadable no-default c-mode." "result overloadable no-default c-mode.") (define-overloadable-function xref-elisp-overloadable-co-located-default () - "doc string overloadable co-located-default" + "Doc string overloadable co-located-default." "result overloadable co-located-default.") (define-mode-local-override xref-elisp-overloadable-co-located-default c-mode (_start _end &optional _nonterminal _depth _returnonerror) - "doc string overloadable co-located-default c-mode." + "Doc string overloadable co-located-default c-mode." "result overloadable co-located-default c-mode.") (define-overloadable-function xref-elisp-overloadable-separate-default () - "doc string overloadable separate-default.") + "Doc string overloadable separate-default.") (defun xref-elisp-overloadable-separate-default-default () - "doc string overloadable separate-default default" + "Doc string overloadable separate-default default." "result overloadable separate-default.") (define-mode-local-override xref-elisp-overloadable-separate-default c-mode (_start _end &optional _nonterminal _depth _returnonerror) - "doc string overloadable separate-default c-mode." + "Doc string overloadable separate-default c-mode." "result overloadable separate-default c-mode.") (xref-elisp-deftest find-defs-define-overload-no-methods diff --git a/test/lisp/progmodes/etags-tests.el b/test/lisp/progmodes/etags-tests.el index 35a2592e76f..9b14a3ae860 100644 --- a/test/lisp/progmodes/etags-tests.el +++ b/test/lisp/progmodes/etags-tests.el @@ -111,3 +111,5 @@ (should (visit-tags-table-buffer)) (should (equal tags-file-name (car tag-tables))))) (delete-file file)))) + +;;; etags-tests.el ends here diff --git a/test/lisp/progmodes/flymake-tests.el b/test/lisp/progmodes/flymake-tests.el index 10111ca06cd..4c0d15d1e1b 100644 --- a/test/lisp/progmodes/flymake-tests.el +++ b/test/lisp/progmodes/flymake-tests.el @@ -193,7 +193,7 @@ SEVERITY-PREDICATE is used to setup (defun flymake-tests--diagnose-words (report-fn type words) - "Helper. Call REPORT-FN with diagnostics for WORDS in buffer." + "Helper. Call REPORT-FN with diagnostics for WORDS in buffer." (funcall report-fn (cl-loop for word in words diff --git a/test/lisp/progmodes/gdb-mi-tests.el b/test/lisp/progmodes/gdb-mi-tests.el index ab482214afb..d66df961b63 100644 --- a/test/lisp/progmodes/gdb-mi-tests.el +++ b/test/lisp/progmodes/gdb-mi-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (require 'gdb-mi) @@ -44,3 +46,5 @@ ) (provide 'gdb-mi-tests) + +;;; gdb-mi-tests.el ends here diff --git a/test/lisp/progmodes/opascal-tests.el b/test/lisp/progmodes/opascal-tests.el index 682f2c6cb6b..ea91479362d 100644 --- a/test/lisp/progmodes/opascal-tests.el +++ b/test/lisp/progmodes/opascal-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (require 'opascal) diff --git a/test/lisp/progmodes/pascal-tests.el b/test/lisp/progmodes/pascal-tests.el index e9c705806b3..f5202143e20 100644 --- a/test/lisp/progmodes/pascal-tests.el +++ b/test/lisp/progmodes/pascal-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (require 'pascal) @@ -61,3 +63,5 @@ (should (equal (point) 15)))) (provide 'pascal-tests) + +;;; pascal-tests.el ends here diff --git a/test/lisp/progmodes/sql-tests.el b/test/lisp/progmodes/sql-tests.el index 21dd0649529..99b79b61d65 100644 --- a/test/lisp/progmodes/sql-tests.el +++ b/test/lisp/progmodes/sql-tests.el @@ -50,7 +50,7 @@ (lambda (_command) t)) ((symbol-function 'process-lines) (lambda (_program &rest _args) - (error "some error")))) + (error "Some error")))) (should-not (sql-postgres-list-databases)))) ;;; Check Connection Password Handling/Wallet diff --git a/test/lisp/ps-print-tests.el b/test/lisp/ps-print-tests.el index b25e88622d8..d468911dd3d 100644 --- a/test/lisp/ps-print-tests.el +++ b/test/lisp/ps-print-tests.el @@ -34,3 +34,5 @@ (autoloadp (symbol-function 'ps-mule-initialize)))) + +;;; ps-print-tests.el ends here diff --git a/test/lisp/saveplace-tests.el b/test/lisp/saveplace-tests.el index 17199ed443a..63577fdd167 100644 --- a/test/lisp/saveplace-tests.el +++ b/test/lisp/saveplace-tests.el @@ -21,6 +21,8 @@ ;;; Commentary: +;;; Code: + (require 'ert) (require 'ert-x) (require 'saveplace) diff --git a/test/lisp/ses-tests.el b/test/lisp/ses-tests.el index 04f255dcd4c..9a7fb502d7c 100644 --- a/test/lisp/ses-tests.el +++ b/test/lisp/ses-tests.el @@ -175,3 +175,5 @@ to `ses--bar' and inserting a row, makes A2 value empty, and `ses--bar' equal to (provide 'ses-tests) + +;;; ses-tests.el ends here diff --git a/test/lisp/shell-tests.el b/test/lisp/shell-tests.el index 223a18590b1..342b421911f 100644 --- a/test/lisp/shell-tests.el +++ b/test/lisp/shell-tests.el @@ -1,4 +1,4 @@ -;;; shell-tests.el -*- lexical-binding:t -*- +;;; shell-tests.el --- Tests for shell.el -*- lexical-binding:t -*- ;; Copyright (C) 2010-2021 Free Software Foundation, Inc. diff --git a/test/lisp/simple-tests.el b/test/lisp/simple-tests.el index 3ece61290bc..742da0bde59 100644 --- a/test/lisp/simple-tests.el +++ b/test/lisp/simple-tests.el @@ -972,4 +972,4 @@ See Bug#21722." (should (= (length (delq nil (undo-make-selective-list 6 9))) 0)))) (provide 'simple-test) -;;; simple-test.el ends here +;;; simple-tests.el ends here diff --git a/test/lisp/so-long-tests/so-long-tests-helpers.el b/test/lisp/so-long-tests/so-long-tests-helpers.el index dd2331e6e4a..f542806ac16 100644 --- a/test/lisp/so-long-tests/so-long-tests-helpers.el +++ b/test/lisp/so-long-tests/so-long-tests-helpers.el @@ -106,8 +106,8 @@ (defun so-long-tests-remember () "Remember the original states of modes and variables. -Call this after setting up a buffer in the normal (not so-long) -state for its major mode, so that after triggering a so-long +Call this after setting up a buffer in the normal (not `so-long') +state for its major mode, so that after triggering a `so-long' action we can call `so-long-revert' and compare the reverted state against this remembered state." (setq so-long-tests-memory nil) diff --git a/test/lisp/tar-mode-tests.el b/test/lisp/tar-mode-tests.el index 48a127157dd..6964d423185 100644 --- a/test/lisp/tar-mode-tests.el +++ b/test/lisp/tar-mode-tests.el @@ -47,4 +47,4 @@ (provide 'tar-mode-tests) -;; tar-mode-tests.el ends here +;;; tar-mode-tests.el ends here diff --git a/test/lisp/term/tty-colors-tests.el b/test/lisp/term/tty-colors-tests.el index ba29a9c376e..d0e739b5ec9 100644 --- a/test/lisp/term/tty-colors-tests.el +++ b/test/lisp/term/tty-colors-tests.el @@ -35,4 +35,4 @@ (provide 'term-tests) -;;; term-tests.el ends here +;;; tty-colors-tests.el ends here diff --git a/test/lisp/textmodes/dns-mode-tests.el b/test/lisp/textmodes/dns-mode-tests.el index 8bc48732c62..1be5291509f 100644 --- a/test/lisp/textmodes/dns-mode-tests.el +++ b/test/lisp/textmodes/dns-mode-tests.el @@ -77,3 +77,5 @@ (insert " ") (dns-mode-ipv6-to-nibbles nil) (should (equal (buffer-string) "8.b.d.0.1.0.0.2.ip6.arpa. "))))) + +;;; dns-mode-tests.el ends here diff --git a/test/lisp/thingatpt-tests.el b/test/lisp/thingatpt-tests.el index 1849480347e..2a32dc57b1c 100644 --- a/test/lisp/thingatpt-tests.el +++ b/test/lisp/thingatpt-tests.el @@ -70,7 +70,7 @@ ;; UUID, only hex is allowed ("01234567-89ab-cdef-ABCD-EF0123456789" 1 uuid "01234567-89ab-cdef-ABCD-EF0123456789") ("01234567-89ab-cdef-ABCD-EF012345678G" 1 uuid nil)) - "List of thing-at-point tests. + "List of `thing-at-point' tests. Each list element should have the form (STRING POS THING RESULT) @@ -231,4 +231,4 @@ position to retrieve THING.") (goto-char 5) (should (eq (symbol-at-point) 'bar)))) -;;; thingatpt.el ends here +;;; thingatpt-tests.el ends here diff --git a/test/lisp/time-stamp-tests.el b/test/lisp/time-stamp-tests.el index dc628af19fd..0449704b418 100644 --- a/test/lisp/time-stamp-tests.el +++ b/test/lisp/time-stamp-tests.el @@ -86,7 +86,7 @@ (should (equal (time-stamp-string "%H %Z" ref-time1) "15 GMT"))))) (iter-defun time-stamp-test-pattern-sequential () - "Iterate through each possibility for a part of time-stamp-pattern." + "Iterate through each possibility for a part of `time-stamp-pattern'." (let ((pattern-value-parts '(("4/" "10/" "-4/" "0/" "") ;0: line limit ("stamp<" "") ;1: start @@ -115,7 +115,7 @@ (extract-part 5)))))))))) (iter-defun time-stamp-test-pattern-multiply () - "Iterate through every combination of parts of time-stamp-pattern." + "Iterate through every combination of parts of `time-stamp-pattern'." (let ((line-limit-values '("" "4/")) (start-values '("" "stamp<")) (format-values '("%%" "%m")) @@ -871,7 +871,7 @@ The functions in `pattern-mod' are composed left to right." (defmacro formatz-generate-tests (form-strings hour-mod mins-mod secs-mod big-mod secbig-mod) - "Defines ert-deftest tests for time formats FORM-STRINGS. + "Defines tests for time formats FORM-STRINGS. FORM-STRINGS is a list of formats, each \"%z\" or some variation thereof. Each of the remaining arguments is an unquoted list of the form diff --git a/test/lisp/time-tests.el b/test/lisp/time-tests.el index 88b7638d91d..89e6985b842 100644 --- a/test/lisp/time-tests.el +++ b/test/lisp/time-tests.el @@ -21,6 +21,8 @@ ;;; Commentary: +;;; Code: + (require 'ert) (require 'ert-x) (require 'time) diff --git a/test/lisp/timezone-tests.el b/test/lisp/timezone-tests.el index 9f6961409e6..9bbe36cfe8a 100644 --- a/test/lisp/timezone-tests.el +++ b/test/lisp/timezone-tests.el @@ -21,6 +21,8 @@ ;;; Commentary: +;;; Code: + (require 'ert) (require 'timezone) diff --git a/test/lisp/url/url-parse-tests.el b/test/lisp/url/url-parse-tests.el index 2418af40aca..a7f81eba8f5 100644 --- a/test/lisp/url/url-parse-tests.el +++ b/test/lisp/url/url-parse-tests.el @@ -23,7 +23,7 @@ ;;; Commentary: ;; Test cases covering generic URI syntax as described in RFC3986, -;; section 3. Syntax Components and 4. Usage. See also appendix +;; section 3. Syntax Components and 4. Usage. See also appendix ;; A. Collected ABNF for URI, as the example given here are all ;; productions of this grammar. diff --git a/test/lisp/vc/add-log-tests.el b/test/lisp/vc/add-log-tests.el index dc2b9961c6c..70e49fe57fe 100644 --- a/test/lisp/vc/add-log-tests.el +++ b/test/lisp/vc/add-log-tests.el @@ -29,8 +29,8 @@ content marker expected-defun) "Generate an ert test for mode-own `add-log-current-defun-function'. Run `add-log-current-defun' at the point where MARKER specifies -in a buffer which content is CONTENT under major mode MODE. Then -it compares the result with EXPECTED-DEFUN." +in a buffer which content is CONTENT under major mode MODE. +Then it compares the result with EXPECTED-DEFUN." (let ((xname (intern (concat "add-log-current-defun-test-" (symbol-name name) )))) diff --git a/test/lisp/vc/diff-mode-tests.el b/test/lisp/vc/diff-mode-tests.el index fefe50d5173..ef19fe0e0e8 100644 --- a/test/lisp/vc/diff-mode-tests.el +++ b/test/lisp/vc/diff-mode-tests.el @@ -481,3 +481,4 @@ baz")))) '("/tmp/ange-ftp1351895K.el" "/tmp/ange-ftp13518wvE.el"))))) (provide 'diff-mode-tests) +;;; diff-mode-tests.el ends here diff --git a/test/lisp/vc/smerge-mode-tests.el b/test/lisp/vc/smerge-mode-tests.el index 2c8f48618e5..d7827c7a8cb 100644 --- a/test/lisp/vc/smerge-mode-tests.el +++ b/test/lisp/vc/smerge-mode-tests.el @@ -34,3 +34,5 @@ (should (equal (buffer-substring (point-min) (point-max)) "")))) (provide 'smerge-mode-tests) + +;;; smerge-mode-tests.el ends here diff --git a/test/lisp/vc/vc-bzr-tests.el b/test/lisp/vc/vc-bzr-tests.el index b02dce8f707..43385de5955 100644 --- a/test/lisp/vc/vc-bzr-tests.el +++ b/test/lisp/vc/vc-bzr-tests.el @@ -153,4 +153,4 @@ t))) (delete-directory homedir t)))) -;;; vc-bzr.el ends here +;;; vc-bzr-tests.el ends here diff --git a/test/lisp/whitespace-tests.el b/test/lisp/whitespace-tests.el index 9f54a4fd340..1001476a286 100644 --- a/test/lisp/whitespace-tests.el +++ b/test/lisp/whitespace-tests.el @@ -51,7 +51,7 @@ ;; We cannot call whitespace-mode because it will do nothing in batch ;; mode. So we call its innards instead. (defun whitespace-tests-whitespace-mode-on () - "Turn whitespace-mode on even in batch mode." + "Turn `whitespace-mode' on even in batch mode." (whitespace-turn-on) (whitespace-action-when-on) (setq whitespace-mode t)) diff --git a/test/lisp/xml-tests.el b/test/lisp/xml-tests.el index b00b58acfc5..7c64ef39f8d 100644 --- a/test/lisp/xml-tests.el +++ b/test/lisp/xml-tests.el @@ -78,7 +78,7 @@ ;; Bug#16344 "< /x>" "< b/>") - "List of XML strings that should signal an error in the parser") + "List of XML strings that should signal an error in the parser.") (defvar xml-parse-tests--qnames '( ;; Test data for name expansion @@ -199,4 +199,4 @@ Parser is called with and without 'symbol-qnames argument.") ;; no-byte-compile: t ;; End: -;;; xml-parse-tests.el ends here. +;;; xml-tests.el ends here diff --git a/test/manual/biditest.el b/test/manual/biditest.el index a77fc158807..c84e7ed7310 100644 --- a/test/manual/biditest.el +++ b/test/manual/biditest.el @@ -121,3 +121,5 @@ BidiCharacterTest.txt file." (message "%s" (bidi-resolved-levels))) (define-key global-map [f8] #'bidi-levels) + +;;; biditest.el ends here diff --git a/test/manual/cedet/ede-tests.el b/test/manual/cedet/ede-tests.el index 2af50860c60..17618381ef2 100644 --- a/test/manual/cedet/ede-tests.el +++ b/test/manual/cedet/ede-tests.el @@ -80,4 +80,4 @@ The search is done with the current EDE root." (ede-locate-file-in-project loc file) (data-debug-insert-object-slots loc "]"))) -;;; ede-test.el ends here +;;; ede-tests.el ends here diff --git a/test/manual/cedet/semantic-tests.el b/test/manual/cedet/semantic-tests.el index 044db29cda7..3e416cc6b20 100644 --- a/test/manual/cedet/semantic-tests.el +++ b/test/manual/cedet/semantic-tests.el @@ -271,3 +271,5 @@ tag that contains point, and return that." Lcount (semantic-tag-name target) (semantic-elapsed-time start nil))) Lcount))) + +;;; semantic-tests.el ends here diff --git a/test/manual/cedet/tests/test.el b/test/manual/cedet/tests/test.el index d1d0d1602f4..34c03619f88 100644 --- a/test/manual/cedet/tests/test.el +++ b/test/manual/cedet/tests/test.el @@ -19,31 +19,29 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . -;;; Require -;; +;;; Code: + (require 'semantic) (require 'eieio "../eieio") ;; tags encapsulated in eval-when-compile and eval-and-compile ;; should be expanded out into the outer environment. (eval-when-compile - (require 'semantic-imenu) - ) + (require 'semantic-imenu)) (eval-and-compile (defconst const-1 nil) (defun function-1 (arg) - nil) - ) + nil)) ;;; Functions ;; (defun a-defun (arg1 arg2 &optional arg3) - "doc a" + "Doc a." nil) (defun a-defun-interactive (arg1 arg2 &optional arg3) - "doc a that is a command" + "Doc a that is a command." (interactive "R") nil) @@ -52,15 +50,15 @@ nil) (defsubst a-defsubst (arg1 arg2 &optional arg3) - "doc a-subst" + "Doc a-subst." nil) (defmacro a-defmacro (arg1 arg2 &optional arg3) - "doc a-macro" + "Doc a-macro." nil) (define-overload a-overload (arg) - "doc a-overload" + "Doc a-overload." nil) ;;; Methods @@ -81,16 +79,16 @@ ;;; Variables ;; (defvar a-defvar (cons 1 2) - "Variable a") + "Variable a.") ;; FIXME: This practice is not recommended in recent Emacs. Remove? (defvar a-defvar-star (cons 1 2) - "*User visible var a") + "*User visible var a.") -(defconst a-defconst 'a "var doc const") +(defconst a-defconst 'a "Var doc const.") (defcustom a-defcustom nil - "doc custom" + "Doc custom." :group 'a-defgroup :type 'boolean) @@ -111,7 +109,7 @@ (defgroup a-defgroup nil - "Group for `emacs-lisp' regression-test") + "Group for `emacs-lisp' regression-test.") ;;; Classes ;; @@ -154,3 +152,5 @@ "some value") (provide 'test) + +;;; test.el ends here diff --git a/test/manual/etags/el-src/emacs/lisp/progmodes/etags.el b/test/manual/etags/el-src/emacs/lisp/progmodes/etags.el index 36f6624472d..86cc8825466 100644 --- a/test/manual/etags/el-src/emacs/lisp/progmodes/etags.el +++ b/test/manual/etags/el-src/emacs/lisp/progmodes/etags.el @@ -732,7 +732,7 @@ Returns t if it visits a tags table, or nil if there are no more in the list." "Return the file name of the file whose tags point is within. Assumes the tags table is the current buffer. If RELATIVE is non-nil, file name returned is relative to tags -table file's directory. If RELATIVE is nil, file name returned +table file's directory. If RELATIVE is nil, file name returned is complete." (funcall file-of-tag-function relative)) diff --git a/test/manual/image-size-tests.el b/test/manual/image-size-tests.el index 44846a7a67a..067a0bfc8e2 100644 --- a/test/manual/image-size-tests.el +++ b/test/manual/image-size-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Commentary: + ;; To test: Load the file and eval (image-size-tests). ;; A non-erroring result is a success. diff --git a/test/manual/image-transforms-tests.el b/test/manual/image-transforms-tests.el index debb74f2edb..acbaed5c0b6 100644 --- a/test/manual/image-transforms-tests.el +++ b/test/manual/image-transforms-tests.el @@ -174,3 +174,5 @@ (test-scaling) (test-scaling-rotation) (goto-char (point-min)))) + +;;; image-transforms-tests.el ends here diff --git a/test/manual/redisplay-testsuite.el b/test/manual/redisplay-testsuite.el index 8e90f2d7a5c..8a4828417c8 100644 --- a/test/manual/redisplay-testsuite.el +++ b/test/manual/redisplay-testsuite.el @@ -350,3 +350,5 @@ static unsigned char x_bits[] = {0xff, 0x81, 0xbd, 0xa5, 0xa5, 0xbd, 0x81, 0xff (test-redisplay-4) (test-redisplay-5) (goto-char (point-min)))) + +;;; redisplay-testsuite.el ends here diff --git a/test/misc/test-custom-libs.el b/test/misc/test-custom-libs.el index cc2be99dea8..d826dfbcab4 100644 --- a/test/misc/test-custom-libs.el +++ b/test/misc/test-custom-libs.el @@ -19,7 +19,7 @@ ;;; Commentary: -;; This file runs for all libraries with autoloads separate emacs +;; This file runs for all libraries with autoloads separate Emacs ;; processes of the form "emacs -batch -l LIB". ;;; Code: @@ -45,4 +45,4 @@ (cus-test-libs t) (should-not cus-test-libs-errors)) -;;; test-custom-deps.el ends here +;;; test-custom-libs.el ends here diff --git a/test/src/alloc-tests.el b/test/src/alloc-tests.el index 1324c2d3b4d..5383c436035 100644 --- a/test/src/alloc-tests.el +++ b/test/src/alloc-tests.el @@ -58,3 +58,5 @@ (dolist (c (list 10003 ?b 128 ?c ?d (max-char) ?e)) (aset s 0 c) (should (equal s (make-string 1 c)))))) + +;;; alloc-tests.el ends here diff --git a/test/src/character-tests.el b/test/src/character-tests.el index f630b32a5ee..ba24d49039c 100644 --- a/test/src/character-tests.el +++ b/test/src/character-tests.el @@ -43,3 +43,5 @@ (should (= (string-width "áëòç" nil 4) 2)) (should (= (string-width "הַרְבֵּה אַהֲבָה") 9)) (should (= (string-width "הַרְבֵּה אַהֲבָה" nil 8) 4))) + +;;; character-tests.el ends here diff --git a/test/src/charset-tests.el b/test/src/charset-tests.el index 5c46627c163..23e201ad453 100644 --- a/test/src/charset-tests.el +++ b/test/src/charset-tests.el @@ -22,7 +22,9 @@ (require 'ert) (ert-deftest charset-decode-char () - "Test decode-char." + "Test `decode-char'." (should-error (decode-char 'ascii 0.5))) (provide 'charset-tests) + +;;; charset-tests.el ends here diff --git a/test/src/coding-tests.el b/test/src/coding-tests.el index 134f5676709..1c585ea5377 100644 --- a/test/src/coding-tests.el +++ b/test/src/coding-tests.el @@ -434,4 +434,4 @@ ;; End: (provide 'coding-tests) -;; coding-tests.el ends here +;;; coding-tests.el ends here diff --git a/test/src/comp-resources/comp-test-funcs.el b/test/src/comp-resources/comp-test-funcs.el index f2a246320ac..eb2521e5d34 100644 --- a/test/src/comp-resources/comp-test-funcs.el +++ b/test/src/comp-resources/comp-test-funcs.el @@ -202,7 +202,7 @@ (defun comp-tests-err-arith-f () (/ 1 0)) (defun comp-tests-err-foo-f () - (error "foo")) + (error "Foo")) (defun comp-tests-condition-case-0-f () ;; Bpushhandler Bpophandler @@ -264,7 +264,7 @@ (% a b))) (defun comp-tests-doc-f () - "A nice docstring" + "A nice docstring." t) (defun comp-test-interactive-form0-f (dir) @@ -479,7 +479,7 @@ family))) (defun comp-test-46670-1-f (_) - "foo") + "Foo.") (defun comp-test-46670-2-f (s) (and (equal (comp-test-46670-1-f (length s)) s) @@ -647,7 +647,7 @@ (?> 2)))) (defun comp-test-big-interactive (filename &optional force arg load) - ;; Check non trivial interactive form using `byte-recompile-file'. + "Check non trivial interactive form using `byte-recompile-file'." (interactive (let ((file buffer-file-name) (file-name nil) @@ -683,17 +683,17 @@ (defun comp-test-no-return-1 (x) (while x - (error "foo"))) + (error "Foo"))) (defun comp-test-no-return-2 (x) (cond ((eql x '2) t) - ((error "bar") nil))) + ((error "Bar") nil))) (defun comp-test-no-return-3 ()) (defun comp-test-no-return-4 (x) (when x - (error "foo") + (error "Foo") (while (comp-test-no-return-3) (comp-test-no-return-3)))) diff --git a/test/src/comp-tests.el b/test/src/comp-tests.el index fb9441eb66e..f1778b38568 100644 --- a/test/src/comp-tests.el +++ b/test/src/comp-tests.el @@ -1167,7 +1167,7 @@ Return a list of results." ;; 49 ((defun comp-tests-ret-type-spec-f () - (error "foo")) + (error "Foo")) nil) ;; 50 @@ -1373,7 +1373,7 @@ Return a list of results." (defun comp-tests-pure-checker-1 (_) "Check that inside `comp-tests-pure-caller-f' `comp-tests-pure-callee-f' is - folded." +folded." (should (cl-notany #'identity diff --git a/test/src/data-tests.el b/test/src/data-tests.el index b1e5fa0767c..03dfae8cc3c 100644 --- a/test/src/data-tests.el +++ b/test/src/data-tests.el @@ -26,10 +26,10 @@ (defconst data-tests--float-greater-than-fixnums (+ 1.0 most-positive-fixnum) "A floating-point value that is greater than all fixnums. It is also as small as conveniently possible, to make the tests sharper. -Adding 1.0 to most-positive-fixnum should suffice on all +Adding 1.0 to `most-positive-fixnum' should suffice on all practical Emacs platforms, since the result is a power of 2 and this is exactly representable and is greater than -most-positive-fixnum, which is just less than a power of 2.") +`most-positive-fixnum', which is just less than a power of 2.") (ert-deftest data-tests-= () (should-error (=)) @@ -204,11 +204,11 @@ most-positive-fixnum, which is just less than a power of 2.") ""))) (defun test-bool-vector-count-consecutive-tc (desc) - "Run a test case for bool-vector-count-consecutive. + "Run a test case for `bool-vector-count-consecutive'. DESC is a string describing the test. It is a sequence of hexadecimal digits describing the bool vector. We exhaustively test all counts at all possible positions in the vector by -comparing the subr with a much slower lisp implementation." +comparing the subr with a much slower Lisp implementation." (let ((bv (test-bool-vector-bv-from-hex-string desc))) (cl-loop for lf in '(nil t) @@ -338,7 +338,7 @@ comparing the subr with a much slower lisp implementation." (should (eq binding-test-some-local 'local)))) (ert-deftest binding-test-setq-default () - "Test that a setq-default has no effect when there is a local binding." + "Test that a `setq-default' has no effect when there is a local binding." (with-current-buffer binding-test-buffer-B ;; This variable is not local in this buffer. (let ((binding-test-some-local 'something-else)) @@ -399,28 +399,28 @@ comparing the subr with a much slower lisp implementation." (eq binding-test-some-local 'outer)))))) (ert-deftest binding-test-defvar-bool () - "Test DEFVAR_BOOL" + "Test DEFVAR_BOOL." (let ((display-hourglass 5)) (should (eq display-hourglass t)))) (ert-deftest binding-test-defvar-int () - "Test DEFVAR_INT" + "Test DEFVAR_INT." (should-error (setq gc-cons-threshold 5.0) :type 'wrong-type-argument)) (ert-deftest binding-test-set-constant-t () - "Test setting the constant t" + "Test setting the constant t." (with-no-warnings (should-error (setq t 'bob) :type 'setting-constant))) (ert-deftest binding-test-set-constant-nil () - "Test setting the constant nil" + "Test setting the constant nil." (with-no-warnings (should-error (setq nil 'bob) :type 'setting-constant))) (ert-deftest binding-test-set-constant-keyword () - "Test setting a keyword constant" + "Test setting a keyword constant." (with-no-warnings (should-error (setq :keyword 'bob) :type 'setting-constant))) (ert-deftest binding-test-set-constant-nil () - "Test setting a keyword to itself" + "Test setting a keyword to itself." (with-no-warnings (should (setq :keyword :keyword)))) (ert-deftest data-tests--set-default-per-buffer () diff --git a/test/src/decompress-tests.el b/test/src/decompress-tests.el index 520445cca5a..1d25cf2f66b 100644 --- a/test/src/decompress-tests.el +++ b/test/src/decompress-tests.el @@ -42,4 +42,4 @@ (provide 'decompress-tests) -;;; decompress-tests.el ends here. +;;; decompress-tests.el ends here diff --git a/test/src/fileio-tests.el b/test/src/fileio-tests.el index 438ebebb769..4143503aa18 100644 --- a/test/src/fileio-tests.el +++ b/test/src/fileio-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (defun try-link (target link) @@ -97,7 +99,7 @@ Also check that an encoding error can appear in a symlink." (should (equal (file-name-as-directory "D:/abc//") "d:/abc//"))) (ert-deftest fileio-tests--relative-HOME () - "Test that expand-file-name works even when HOME is relative." + "Test that `expand-file-name' works even when HOME is relative." (let ((process-environment (copy-sequence process-environment))) (setenv "HOME" "a/b/c") (should (equal (expand-file-name "~/foo") @@ -128,7 +130,7 @@ Also check that an encoding error can appear in a symlink." (if f (delete-file f))))) (ert-deftest fileio-tests--relative-default-directory () - "Test expand-file-name when default-directory is relative." + "Test `expand-file-name' when `default-directory' is relative." (let ((default-directory "some/relative/name")) (should (file-name-absolute-p (expand-file-name "foo")))) (let* ((default-directory "~foo") @@ -137,7 +139,7 @@ Also check that an encoding error can appear in a symlink." (not (eq (aref name 0) ?~)))))) (ert-deftest fileio-test--expand-file-name-null-bytes () - "Test that expand-file-name checks for null bytes in filenames." + "Test that `expand-file-name' checks for null bytes in filenames." (should-error (expand-file-name (concat "file" (char-to-string ?\0) ".txt")) :type 'wrong-type-argument) (should-error (expand-file-name "file.txt" (concat "dir" (char-to-string ?\0))) @@ -146,7 +148,7 @@ Also check that an encoding error can appear in a symlink." (should-error (expand-file-name "file.txt") :type 'wrong-type-argument))) (ert-deftest fileio-tests--file-name-absolute-p () - "Test file-name-absolute-p." + "Test `file-name-absolute-p'." (dolist (suffix '("" "/" "//" "/foo" "/foo/" "/foo//" "/foo/bar")) (unless (string-equal suffix "") (should (file-name-absolute-p suffix))) @@ -157,7 +159,7 @@ Also check that an encoding error can appear in a symlink." (should (not (file-name-absolute-p (concat "~nosuchuser" suffix))))))) (ert-deftest fileio-tests--circular-after-insert-file-functions () - "Test after-insert-file-functions as a circular list." + "Test `after-insert-file-functions' as a circular list." (let ((f (make-temp-file "fileio")) (after-insert-file-functions (list 'identity))) (setcdr after-insert-file-functions after-insert-file-functions) diff --git a/test/src/floatfns-tests.el b/test/src/floatfns-tests.el index 4a3c03d833e..47fa1941626 100644 --- a/test/src/floatfns-tests.el +++ b/test/src/floatfns-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (ert-deftest divide-extreme-sign () @@ -125,3 +127,5 @@ (ash (1- (ash 1 53)) 2045)))) (provide 'floatfns-tests) + +;;; floatfns-tests.el ends here diff --git a/test/src/fns-tests.el b/test/src/fns-tests.el index bd5a4358e65..57594572094 100644 --- a/test/src/fns-tests.el +++ b/test/src/fns-tests.el @@ -1114,3 +1114,5 @@ (should (= (line-number-at-pos nil) 11)) (should-error (line-number-at-pos -1)) (should-error (line-number-at-pos 100)))) + +;;; fns-tests.el ends here diff --git a/test/src/indent-tests.el b/test/src/indent-tests.el index 6a3f1a5c95f..6cfe64c07e4 100644 --- a/test/src/indent-tests.el +++ b/test/src/indent-tests.el @@ -57,3 +57,5 @@ (move-to-column 12 t) (buffer-substring-no-properties 1 14)) "\txxx \tLine"))) + +;;; indent-tests.el ends here diff --git a/test/src/inotify-tests.el b/test/src/inotify-tests.el index 5572c7d7a0f..8aab7eeb30a 100644 --- a/test/src/inotify-tests.el +++ b/test/src/inotify-tests.el @@ -70,4 +70,4 @@ (provide 'inotify-tests) -;;; inotify-tests.el ends here. +;;; inotify-tests.el ends here diff --git a/test/src/lcms-tests.el b/test/src/lcms-tests.el index 40a48f1e9bb..d2d137e9bd5 100644 --- a/test/src/lcms-tests.el +++ b/test/src/lcms-tests.el @@ -95,7 +95,7 @@ B is considered the exact value." '(0.29902 0.31485 1.0)))) (ert-deftest lcms-roundtrip () - "Test accuracy of converting to and from different color spaces" + "Test accuracy of converting to and from different color spaces." (skip-unless (featurep 'lcms2)) (should (let ((color '(.5 .3 .7))) @@ -109,7 +109,7 @@ B is considered the exact value." 0.0001)))) (ert-deftest lcms-ciecam02-gold () - "Test CIE CAM02 JCh gold values" + "Test CIE CAM02 JCh gold values." (skip-unless (featurep 'lcms2)) (should (lcms-triple-approx-p diff --git a/test/src/marker-tests.el b/test/src/marker-tests.el index 234a0b35ea7..cf8e82cd560 100644 --- a/test/src/marker-tests.el +++ b/test/src/marker-tests.el @@ -57,4 +57,4 @@ (set-marker marker-2 marker-1) (should (goto-char marker-2)))) -;;; marker-tests.el ends here. +;;; marker-tests.el ends here diff --git a/test/src/minibuf-tests.el b/test/src/minibuf-tests.el index feea1c112bf..51d9c67453e 100644 --- a/test/src/minibuf-tests.el +++ b/test/src/minibuf-tests.el @@ -414,8 +414,8 @@ (let ((inhibit-interaction t)) (should-error (read-from-minibuffer "foo: ") :type 'inhibited-interaction) - (should-error (y-or-n-p "foo: ") :type 'inhibited-interaction) - (should-error (yes-or-no-p "foo: ") :type 'inhibited-interaction) + (should-error (y-or-n-p "Foo?") :type 'inhibited-interaction) + (should-error (yes-or-no-p "Foo?") :type 'inhibited-interaction) (should-error (read-no-blanks-input "foo: ") :type 'inhibited-interaction) ;; See that we get the expected error. diff --git a/test/src/process-tests.el b/test/src/process-tests.el index 9bab523708e..e39f57d23be 100644 --- a/test/src/process-tests.el +++ b/test/src/process-tests.el @@ -745,7 +745,7 @@ Return nil if that can't be determined." process-tests--EMFILE-message) (ert-deftest process-tests/sentinel-called () - "Check that sentinels are called after processes finish" + "Check that sentinels are called after processes finish." (let ((command (process-tests--emacs-command))) (skip-unless command) (dolist (conn-type '(pipe pty)) diff --git a/test/src/regex-emacs-tests.el b/test/src/regex-emacs-tests.el index 0607eacf397..71e3189443e 100644 --- a/test/src/regex-emacs-tests.el +++ b/test/src/regex-emacs-tests.el @@ -279,11 +279,11 @@ on success" (defconst regex-tests-re-even-escapes "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*" - "Regex that matches an even number of \\ characters") + "Regex that matches an even number of \\ characters.") (defconst regex-tests-re-odd-escapes (concat regex-tests-re-even-escapes "\\\\") - "Regex that matches an odd number of \\ characters") + "Regex that matches an odd number of \\ characters.") (defun regex-tests-unextend (pattern) @@ -396,9 +396,9 @@ pattern)" ;; emacs matches non-greedy regex ab.*? non-greedily 639 677 712 ] - "Line numbers in the boost test that should be skipped. These -are false-positive test failures that represent known/benign -differences in behavior.") + "Line numbers in the boost test that should be skipped. +These are false-positive test failures that represent +known/benign differences in behavior.") ;; - Format ;; - Comments are lines starting with ; @@ -480,9 +480,9 @@ differences in behavior.") ;; ambiguous groupings are ambiguous 610 611 1154 1157 1160 1168 1171 1176 1179 1182 1185 1188 1193 1196 1203 ] - "Line numbers in the PCRE test that should be skipped. These -are false-positive test failures that represent known/benign -differences in behavior.") + "Line numbers in the PCRE test that should be skipped. +These are false-positive test failures that represent +known/benign differences in behavior.") ;; - Format ;; @@ -562,9 +562,9 @@ differences in behavior.") ;; fails to match 168 ] - "Line numbers in the PTESTS test that should be skipped. These -are false-positive test failures that represent known/benign -differences in behavior.") + "Line numbers in the PTESTS test that should be skipped. +These are false-positive test failures that represent +known/benign differences in behavior.") ;; - Format ;; - fields separated by ¦ (note: this is not a |) @@ -621,9 +621,9 @@ differences in behavior.") ;; emacs is more stringent with regexes involving unbalanced ) 67 ] - "Line numbers in the TESTS test that should be skipped. These -are false-positive test failures that represent known/benign -differences in behavior.") + "Line numbers in the TESTS test that should be skipped. +These are false-positive test failures that represent +known/benign differences in behavior.") ;; - Format ;; - fields separated by :. Watch for [\[:xxx:]] diff --git a/test/src/textprop-tests.el b/test/src/textprop-tests.el index b083588e645..c001579c474 100644 --- a/test/src/textprop-tests.el +++ b/test/src/textprop-tests.el @@ -69,4 +69,4 @@ (null stack))))) (provide 'textprop-tests) -;; textprop-tests.el ends here. +;;; textprop-tests.el ends here diff --git a/test/src/thread-tests.el b/test/src/thread-tests.el index fc7bc7441b7..52eace7e9d2 100644 --- a/test/src/thread-tests.el +++ b/test/src/thread-tests.el @@ -70,12 +70,12 @@ (thread-live-p (make-thread #'ignore)))) (ert-deftest threads-all-threads () - "Simple test for all-threads." + "Simple test for `all-threads'." (skip-unless (featurep 'threads)) (should (listp (all-threads)))) (ert-deftest threads-main-thread () - "Simple test for all-threads." + "Simple test for `all-threads'." (skip-unless (featurep 'threads)) (should (eq main-thread (car (all-threads))))) @@ -155,7 +155,7 @@ (should (eq (type-of (make-mutex)) 'mutex))) (ert-deftest threads-mutex-lock-unlock () - "Test mutex-lock and unlock." + "Test `mutex-lock' and unlock." (skip-unless (featurep 'threads)) (should (let ((mx (make-mutex))) @@ -392,4 +392,4 @@ (let ((th (make-thread 'ignore))) (should-not (equal th main-thread)))) -;;; threads.el ends here +;;; thread-tests.el ends here diff --git a/test/src/timefns-tests.el b/test/src/timefns-tests.el index 0a450a7573f..bba9b3fcd8c 100644 --- a/test/src/timefns-tests.el +++ b/test/src/timefns-tests.el @@ -241,3 +241,5 @@ a fixed place on the right and are padded on the left." (let ((xdiv (/ x divisor))) (should (= xdiv (float-time (time-convert xdiv t)))))) (setq x (* x 2))))) + +;;; timefns-tests.el ends here diff --git a/test/src/xfaces-tests.el b/test/src/xfaces-tests.el index 0a7ef55b2b6..cba706f4535 100644 --- a/test/src/xfaces-tests.el +++ b/test/src/xfaces-tests.el @@ -17,6 +17,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see . +;;; Code: + (require 'ert) (ert-deftest xfaces-color-distance () @@ -48,3 +50,5 @@ (should (equal (color-values-from-color-spec "rgbi:0/0.5/10") nil))) (provide 'xfaces-tests) + +;;; xfaces-tests.el ends here diff --git a/test/src/xml-tests.el b/test/src/xml-tests.el index a35b4d2ccc8..7c4ca396f70 100644 --- a/test/src/xml-tests.el +++ b/test/src/xml-tests.el @@ -52,4 +52,4 @@ (should (equal (cdr test) (libxml-parse-xml-region (point-min) (point-max))))))) -;;; libxml-tests.el ends here +;;; xml-tests.el ends here -- 2.39.2