all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: MON KEY <monkey@sandpframing.com>
To: 6525@debbugs.gnu.org
Subject: bug#6525: documentation of macro `with-silent-modifications' 1 typo + multi-horrid
Date: Mon, 28 Jun 2010 03:36:09 -0400	[thread overview]
Message-ID: <AANLkTinCygKcu9LqX8UywEcc_4h9bjph_iMpT7WKDfQ-@mail.gmail.com> (raw)

documentation of macro `with-silent-modifications' lisp/subr.el
current through Bzr-100654

There is a typo @ "... does not modifies the buffer."
should be "... does not modify the buffer."

More generally the docstring is bordering on non-sensical.

,---- (documentation 'with-silent-modifications)
|
| "Execute BODY, pretending it does not modifies the buffer.
| If BODY performs real modifications to the buffer's text, other than
| cosmetic ones, undo data may become corrupted.  Typically used
| around modifications of text-properties which do not really affect
| the buffer's content."
|
`----


Execute BODY, pretending it does not modifies the buffer.
^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^ modify ^^^^^^|^^^^^
        what is a `pretend'                   which buffer?

If BODY performs real modifications to the buffer's text, other than
^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^
    what is a non-real mod?                         ???

cosmetic ones, undo data may become corrupted.  Typically used
^^^|^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^
what is non-cosmetic? |             what is an atypical usage?
                      |
         why not say `buffer-undo-list'?

around modifications of text-properties which do not really affect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^^^^^
                         what is the affector txt-prop or the mod?
the buffer's content.
^^^^^^^^^^^^^|^^^^^^
   exactly what _is_ content - chars, tps, overlays, fields, faces?

--
/s_P\





             reply	other threads:[~2010-06-28  7:36 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-06-28  7:36 MON KEY [this message]
2010-07-01  1:10 ` bug#6525: documentation of macro `with-silent-modifications' 1 typo + multi-horrid Stefan Monnier
2010-07-01 23:07   ` MON KEY
2010-07-04 17:21     ` bug#6525: documentation of macro `with-silent-modifications' 1 Stefan Monnier
2010-07-06 21:29       ` MON KEY
2011-07-13 23:40       ` Lars Magne Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=AANLkTinCygKcu9LqX8UywEcc_4h9bjph_iMpT7WKDfQ-@mail.gmail.com \
    --to=monkey@sandpframing.com \
    --cc=6525@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.