From: Stephen Gildea <stepheng+emacs@gildea.com>
Date: Sun, 13 Oct 2019 14:58:55 +0000 (-0700)
Subject: Minor tweaks to time-stamp documentation strings
X-Git-Tag: emacs-27.0.90~1105
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=d9a01dcd9fe2a0e5f84b708cdd34c3e7e8fb9189;p=emacs.git

Minor tweaks to time-stamp documentation strings

* time-stamp.el (time-stamp): Reformat the explanation of the
variables that affect time-stamp, for easier reading.  In particular,
wrap the documentation to 75 characters, so that it displays neatly as
a before-save-hook customization option.

* time-stamp-tests.el (with-time-stamp-test-env): Use imperative voice,
per checkdoc.
---

diff --git a/lisp/time-stamp.el b/lisp/time-stamp.el
index 6da576f3778..094ef915265 100644
--- a/lisp/time-stamp.el
+++ b/lisp/time-stamp.el
@@ -256,12 +256,14 @@ look like one of the following:
       Time-stamp: \" \"
 The time stamp is written between the brackets or quotes:
       Time-stamp: <2001-02-18 10:20:51 gildea>
-The time stamp is updated only if the variable `time-stamp-active' is non-nil.
-The format of the time stamp is set by the variable `time-stamp-pattern' or
-`time-stamp-format'.  The variables `time-stamp-pattern',
-`time-stamp-line-limit', `time-stamp-start', `time-stamp-end',
-`time-stamp-count', and `time-stamp-inserts-lines' control finding
-the template."
+
+The time stamp is updated only if the variable
+`time-stamp-active' is non-nil.
+The format of the time stamp is set by the variable
+`time-stamp-pattern' or `time-stamp-format'.
+The variables `time-stamp-pattern', `time-stamp-line-limit',
+`time-stamp-start', `time-stamp-end', `time-stamp-count', and
+`time-stamp-inserts-lines' control finding the template."
   (interactive)
   (let ((line-limit time-stamp-line-limit)
 	(ts-start time-stamp-start)
diff --git a/test/lisp/time-stamp-tests.el b/test/lisp/time-stamp-tests.el
index 37822f6e290..4cc4ea1a5b8 100644
--- a/test/lisp/time-stamp-tests.el
+++ b/test/lisp/time-stamp-tests.el
@@ -24,7 +24,7 @@
 (require 'time-stamp)
 
 (defmacro with-time-stamp-test-env (&rest body)
-  "Evaluates BODY with some standard time-stamp test variables bound."
+  "Evaluate BODY with some standard time-stamp test variables bound."
   `(let ((user-login-name "test-logname")
          (user-full-name "Time Stamp Tester")
          (buffer-file-name "/emacs/test/time-stamped-file")