all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 17569@debbugs.gnu.org
Subject: bug#17569: 24.4.50; doc of "wrapper hooks"
Date: Fri, 23 May 2014 15:30:29 -0700 (PDT)	[thread overview]
Message-ID: <6907e1e1-e802-45cd-adad-917290420cf6@default> (raw)

At least two places in the Elisp manual describe a variable as a
"wrapper hook", and send readers off to node `Running Hooks' for more
information.  Alas, there is nothing in that node either about what a
"wrapper hook" is or how it works.

And there is no index entry that matches "wrapper".  OK, so grepping
the Lisp sources for, say, `filter-buffer-substring-functions', one
of the vars whose doc tells you it is a "wrapper hook", gets you to
the Lisp definition of `buffer-substring--filter', a so-called
"internal" function.  And there you discover a macro called
`with-wrapper-hook'.

Finally, the doc for that macro tells you something useful about
"wrapper hooks" (without using the term, however).

It would be helpful to Elisp users to document this macro in the
Elisp manual.  Alas, what else do we read in its doc string?

  This macro is obsolete since 24.4;
  use a <foo>-function variable modified by `add-function'.

On n'arrete pas le progres !  Introduced in Emacs 23.  Never
documented in the manual, and made obsolete in Emacs 24.

Please index and document the concept of "wrapper hook", in the
Elisp manual.  Or whatever this month's fashionable replacement
is for this. Readers of the doc about `abbrev-expand-functions'
or `filter-buffer-substring-functions' should not have to go
fishing into the source code to understand what the doc means
when it says that such a var is a "wrapper hook".

In GNU Emacs 24.4.50.1 (i686-pc-mingw32)
 of 2014-05-17 on ODIEONE
Bzr revision: 117119 eggert@cs.ucla.edu-20140517081131-ugu7ociaoec2xk7y
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/Devel/emacs/snapshot/trunk
 --enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
 LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
 -Ic:/Devel/emacs/include''





             reply	other threads:[~2014-05-23 22:30 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-05-23 22:30 Drew Adams [this message]
2014-05-23 22:45 ` bug#17569: 24.4.50; doc of "wrapper hooks" Glenn Morris
2014-05-23 22:53   ` Drew Adams
2014-05-24  3:21     ` Stefan Monnier
2014-05-24 15:03       ` Drew Adams
2014-05-24 15:16         ` Eli Zaretskii
2014-05-24 20:09       ` Drew Adams
     [not found] <<6907e1e1-e802-45cd-adad-917290420cf6@default>
     [not found] ` <<9pmwe8t8qq.fsf@fencepost.gnu.org>
     [not found]   ` <<17297117-eeea-4bca-a9a3-a08cd966d1fb@default>
     [not found]     ` <<jwvbnun50ay.fsf-monnier+emacsbugs@gnu.org>
     [not found]       ` <<6bad204d-c3d7-4630-aa7f-1a09288f6ad4@default>
     [not found]         ` <<83ppj3jjfq.fsf@gnu.org>
2014-05-24 15:57           ` Drew Adams
2014-05-24 16:21             ` Stefan Monnier
2014-05-24 20:56               ` Glenn Morris
2014-05-24 21:35                 ` Stefan Monnier

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=6907e1e1-e802-45cd-adad-917290420cf6@default \
    --to=drew.adams@oracle.com \
    --cc=17569@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.