diff options
author | Stephen Gildea <stepheng+emacs@gildea.com> | 2019-10-13 07:58:55 -0700 |
---|---|---|
committer | Stephen Gildea <stepheng+emacs@gildea.com> | 2019-10-13 07:59:59 -0700 |
commit | d9a01dcd9fe2a0e5f84b708cdd34c3e7e8fb9189 (patch) | |
tree | 3ab40966e27479a813eb90ce3f2a5ca0470d0021 /lisp/time-stamp.el | |
parent | 9946defe21f2f9b902e5eb86e31aca710e369db1 (diff) | |
download | emacs-d9a01dcd9fe2a0e5f84b708cdd34c3e7e8fb9189.tar.gz |
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.
Diffstat (limited to 'lisp/time-stamp.el')
-rw-r--r-- | lisp/time-stamp.el | 14 |
1 files changed, 8 insertions, 6 deletions
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) |