all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: npostavs@users.sourceforge.net
To: Eli Zaretskii <eliz@gnu.org>
Cc: 24923@debbugs.gnu.org, stephen.berman@gmx.net
Subject: bug#24923: 25.1; Lisp watchpoints
Date: Sun, 20 Nov 2016 14:26:15 -0500	[thread overview]
Message-ID: <87mvguj6lk.fsf@users.sourceforge.net> (raw)
In-Reply-To: <83lgwe9lmo.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 20 Nov 2016 18:11:43 +0200")

Eli Zaretskii <eliz@gnu.org> writes:

>> +changes to the objects referenced by variables are not detected.  For
>> +details, see @xref{Watching Variables}.
>                 ^^^^^
> @xref already generates "See", capitalized, so you want @ref here.
>
>> +Each variable has a list of watch functions stored in its
>> +@code{watchers} symbol property, @xref{Symbol Properties}.
>                                     ^^^^^
> Either "see @ref" or "@pxref", because @xref generates a capitalized
> "See", and so is only appropriate at the beginning of a sentence.

@xref seems to be generating lowercase "see" for me, perhaps because I'm
using makeinfo 4.13?  I'll change to @ref anyway.

>
>> +@defun add-variable-watcher symbol watch-function
>> +This function arranges for @var{watch-function} to be called whenever
>> +@var{symbol} (or any of its aliases @pxref{Variable Aliases}) are
>                                       ^
>> +modified.
>
> A comma is missing here.  Also, I believe "is modified" reads better
> here.  Or maybe replace the parentheses with commas, then plural
> should be okay, I think.

Hmm, maybe rephrasing like this:

    @defun add-variable-watcher symbol watch-function
    This function arranges for @var{watch-function} to be called whenever
    @var{symbol} is modified.  Modifications through aliases
    (@pxref{Variable Aliases}) will have the same effect.





  reply	other threads:[~2016-11-20 19:26 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-11  3:10 bug#24923: 25.1; Lisp watchpoints npostavs
2016-11-11 10:02 ` Eli Zaretskii
2016-11-12  4:34   ` npostavs
2016-11-12  7:19     ` Eli Zaretskii
2016-11-13  0:54       ` npostavs
2016-11-13 15:29         ` Eli Zaretskii
2016-11-20  2:12           ` npostavs
2016-11-20 10:49             ` Stephen Berman
2016-11-20 14:14               ` npostavs
2016-11-20 16:11                 ` Eli Zaretskii
2016-11-20 19:26                   ` npostavs [this message]
2016-11-20 19:36                     ` Eli Zaretskii
2016-11-20 20:16                       ` npostavs
2016-11-21 17:31                         ` Eli Zaretskii
2016-12-03  1:47                           ` npostavs
2016-12-03  3:49                             ` Clément Pit--Claudel
2016-12-03  3:50                             ` Clément Pit--Claudel
2016-12-03  5:01                               ` Daniel Colascione
2016-12-03 14:11                                 ` npostavs
2016-11-20 15:58             ` Eli Zaretskii
2016-11-20 17:00               ` npostavs
2016-11-20 17:25                 ` Eli Zaretskii

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=87mvguj6lk.fsf@users.sourceforge.net \
    --to=npostavs@users.sourceforge.net \
    --cc=24923@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=stephen.berman@gmx.net \
    /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.