diff options
| author | Stephen Gildea | 2019-10-13 07:58:55 -0700 |
|---|---|---|
| committer | Stephen Gildea | 2019-10-13 07:59:59 -0700 |
| commit | d9a01dcd9fe2a0e5f84b708cdd34c3e7e8fb9189 (patch) | |
| tree | 3ab40966e27479a813eb90ce3f2a5ca0470d0021 | |
| parent | 9946defe21f2f9b902e5eb86e31aca710e369db1 (diff) | |
| download | emacs-d9a01dcd9fe2a0e5f84b708cdd34c3e7e8fb9189.tar.gz emacs-d9a01dcd9fe2a0e5f84b708cdd34c3e7e8fb9189.zip | |
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.
| -rw-r--r-- | lisp/time-stamp.el | 14 | ||||
| -rw-r--r-- | test/lisp/time-stamp-tests.el | 2 |
2 files changed, 9 insertions, 7 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: | |||
| 256 | Time-stamp: \" \" | 256 | Time-stamp: \" \" |
| 257 | The time stamp is written between the brackets or quotes: | 257 | The time stamp is written between the brackets or quotes: |
| 258 | Time-stamp: <2001-02-18 10:20:51 gildea> | 258 | Time-stamp: <2001-02-18 10:20:51 gildea> |
| 259 | The time stamp is updated only if the variable `time-stamp-active' is non-nil. | 259 | |
| 260 | The format of the time stamp is set by the variable `time-stamp-pattern' or | 260 | The time stamp is updated only if the variable |
| 261 | `time-stamp-format'. The variables `time-stamp-pattern', | 261 | `time-stamp-active' is non-nil. |
| 262 | `time-stamp-line-limit', `time-stamp-start', `time-stamp-end', | 262 | The format of the time stamp is set by the variable |
| 263 | `time-stamp-count', and `time-stamp-inserts-lines' control finding | 263 | `time-stamp-pattern' or `time-stamp-format'. |
| 264 | the template." | 264 | The variables `time-stamp-pattern', `time-stamp-line-limit', |
| 265 | `time-stamp-start', `time-stamp-end', `time-stamp-count', and | ||
| 266 | `time-stamp-inserts-lines' control finding the template." | ||
| 265 | (interactive) | 267 | (interactive) |
| 266 | (let ((line-limit time-stamp-line-limit) | 268 | (let ((line-limit time-stamp-line-limit) |
| 267 | (ts-start time-stamp-start) | 269 | (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 @@ | |||
| 24 | (require 'time-stamp) | 24 | (require 'time-stamp) |
| 25 | 25 | ||
| 26 | (defmacro with-time-stamp-test-env (&rest body) | 26 | (defmacro with-time-stamp-test-env (&rest body) |
| 27 | "Evaluates BODY with some standard time-stamp test variables bound." | 27 | "Evaluate BODY with some standard time-stamp test variables bound." |
| 28 | `(let ((user-login-name "test-logname") | 28 | `(let ((user-login-name "test-logname") |
| 29 | (user-full-name "Time Stamp Tester") | 29 | (user-full-name "Time Stamp Tester") |
| 30 | (buffer-file-name "/emacs/test/time-stamped-file") | 30 | (buffer-file-name "/emacs/test/time-stamped-file") |