[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master e0e70f0 2/5: with-silent-modifications doc clarific
From: |
Lars Ingebrigtsen |
Subject: |
[Emacs-diffs] master e0e70f0 2/5: with-silent-modifications doc clarification |
Date: |
Sat, 30 Apr 2016 21:54:29 +0000 |
branch: master
commit e0e70f030e69d9696a963a86f5f7caaff4df06eb
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>
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).
---
lisp/subr.el | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/lisp/subr.el b/lisp/subr.el
index a2af642..5f8d830 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -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))