procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor tweaks to time-stamp documentation strings

Browse source 
* 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.
This commit is contained in:
Stephen Gildea 2019-10-13 07:58:55 -07:00
parent 9946defe21
commit d9a01dcd9f
2 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lisp/time-stamp.el
View file

@ -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)

2
test/lisp/time-stamp-tests.el
View file

@ -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")