]> git.eshelyaron.com Git - emacs.git/commitdiff
; Improve documentation of a recent change
authorEli Zaretskii <eliz@gnu.org>
Tue, 2 Nov 2021 15:09:05 +0000 (17:09 +0200)
committerEli Zaretskii <eliz@gnu.org>
Tue, 2 Nov 2021 15:09:05 +0000 (17:09 +0200)
* lisp/files.el (file-has-changed-p): TAG must be a symbol.

* doc/lispref/files.texi (File Attributes): Fix typos.

doc/lispref/files.texi
lisp/files.el

index 84da6eba2fce52ff429db4b582f8a6a2109f1ab3..24f059ea4c6f264d727d394ba361ce46afb4e1e8 100644 (file)
@@ -1318,13 +1318,14 @@ on the 19th, @file{aug-20} was written on the 20th, and the file
 This function returns non-@code{nil} if the time stamp of
 @var{filename} has changed since the last call.  When called for the
 first time for some @var{filename}, it records the last modification
-time ans size of the file and returns non-@code{nil}.  Thereafter,
+time and size of the file, and returns non-@code{nil}.  Thereafter,
 when called for the same @var{filename}, it compares the current time
-stamp and size with the recorded one and returns non-@code{nil} only
-if they are different.  This is useful when a Lisp program wants to
-re-read a file whenever it changes.  With an optional argument
-@var{tag}, the size and modification time comparisons are limited to
-calls with the same tag.
+stamp and size with the recorded ones, and returns non-@code{nil} only
+if either the time stamp or the size (or both) are different.  This is
+useful when a Lisp program wants to re-read a file whenever it
+changes.  With an optional argument @var{tag}, which must be a symbol,
+the size and modification time comparisons are limited to calls with
+the same tag.
 @end defun
 
 @defun file-attributes filename &optional id-format
index d7dfa9399e20ae271386baa7071896cfe0a46cb1..173198a42461a6d0a717bda0e44bec6fee1dce4f 100644 (file)
@@ -6186,13 +6186,13 @@ Return nil if DIR is not an existing directory."
 
 (defun file-has-changed-p (file &optional tag)
   "Return non-nil if FILE has changed.
-The size and modification time of FILE is compared to the size
-and modification time of FILE during a previous invocation of
-`file-has-changed-p'.  Therefore the first invocation of
-`file-has-changed-p' always returns non-nil.
-The optional argument TAG can be used to limit the comparison to
-invocations with identical tags; it can for example be the symbol
-of the calling function."
+The size and modification time of FILE are compared to the size
+and modification time of tghe same FILE during a previous
+invocation of `file-has-changed-p'.  Thus, the first invocation
+of `file-has-changed-p' always returns non-nil.
+The optional argument TAG, which must be a symbol, can be used to
+limit the comparison to invocations with identical tags; it can be
+the symbol of the calling function, for example."
   (let* ((fileattr (file-attributes file 'integer))
         (attr (cons (file-attribute-size fileattr)
                     (file-attribute-modification-time fileattr)))