with-silent-modifications doc clarification

* lisp/subr.el (with-silent-modifications): Rearrange the doc
string a bit so that the most pertinent information is at the
top (bug#21171).
This commit is contained in:
Lars Ingebrigtsen 2016-04-30 23:34:29 +02:00
parent 1aaeaf1450
commit e0e70f030e

View file

@ -3457,6 +3457,8 @@ See also `with-temp-file' and `with-output-to-string'."
(defmacro with-silent-modifications (&rest body)
"Execute BODY, pretending it does not modify the buffer.
This macro is Typically used around modifications of
text-properties which do not really affect the buffer's content.
If BODY performs real modifications to the buffer's text, other
than cosmetic ones, undo data may become corrupted.
@ -3464,10 +3466,7 @@ This macro will run BODY normally, but doesn't count its buffer
modifications as being buffer modifications. This affects things
like `buffer-modified-p', checking whether the file is locked by
someone else, running buffer modification hooks, and other things
of that nature.
Typically used around modifications of text-properties which do
not really affect the buffer's content."
of that nature."
(declare (debug t) (indent 0))
(let ((modified (make-symbol "modified")))
`(let* ((,modified (buffer-modified-p))