From: Stefan Monnier <monnier@iro.umontreal.ca>
To: MON KEY <monkey@sandpframing.com>
Cc: 6525@debbugs.gnu.org
Subject: bug#6525: documentation of macro `with-silent-modifications' 1 typo + multi-horrid
Date: Thu, 01 Jul 2010 03:10:11 +0200 [thread overview]
Message-ID: <jwv8w5w3tbo.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <AANLkTinCygKcu9LqX8UywEcc_4h9bjph_iMpT7WKDfQ-@mail.gmail.com> (MON KEY's message of "Mon, 28 Jun 2010 03:36:09 -0400")
> cosmetic ones, undo data may become corrupted. Typically used
> ^^^|^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^
> what is non-cosmetic? | what is an atypical usage?
> |
> why not say `buffer-undo-list'?
Docstrings should generally only document what the function/macro does,
rather than how they're used. So the "typical uses" I put here is
actually a bad idea, tho it was just easier to do that than to try and
describe what the macro does, especially since it's really the use for
which it's designed. I don't know what atypical uses might be, and
don't care about them (at least until they come complaining about some
undesirable part of the behavior).
> around modifications of text-properties which do not really affect
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^|^^^^^^^^^^^^^^^^^^^^^^^^^
> what is the affector txt-prop or the mod?
Some other code: the caller would presumably know.
> the buffer's content.
> ^^^^^^^^^^^^^|^^^^^^
> exactly what _is_ content - chars, tps, overlays, fields, faces?
Can be any of it, depending on the case, because it's a conceptual
notion, rather than a technical one: typically "modify the buffer's
content" means "saving the buffer results in a different file".
Stefan
next prev parent reply other threads:[~2010-07-01 1:10 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-06-28 7:36 bug#6525: documentation of macro `with-silent-modifications' 1 typo + multi-horrid MON KEY
2010-07-01 1:10 ` Stefan Monnier [this message]
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=jwv8w5w3tbo.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=6525@debbugs.gnu.org \
--cc=monkey@sandpframing.com \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).