all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: bug#5274: 23.1; doc string of ad-add-advice
Date: Sun, 27 Dec 2009 09:29:52 -0800	[thread overview]
Message-ID: <CFDCB17E34EC41FEBE68227204FBB4DF@us.oracle.com> (raw)

Doc string:
 
"Add a piece of ADVICE to FUNCTION's list of advices in CLASS.
If FUNCTION already has one or more pieces of advice of the specified
CLASS then POSITION determines where the new piece will go.  The value
of POSITION can either be `first', `last' or a number where 0 corresponds
to `first'.  Numbers outside the range will be mapped to the closest
extreme position.  If there was already a piece of ADVICE with the same
name, then the position argument will be ignored and the old advice
will be overwritten with the new one.
    If the FUNCTION was not advised already, then its advice info will be
initialized.  Redefining a piece of advice whose name is part of the cache-id
will clear the cache."
 
None of the parameters, except POSITION, are described. OK, one can
guess that FUNCTION is a function (but `functionp' or `fboundp'?), but
there is no indication what ADVICE, CLASS, and POSITION are - what
forms they can take.  Might as well say "a piece of FOO" and "list of
foos in THROMBIT".

Each of these parameters needs to be described, just as we do for any
other function's parameters.
 

In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
 of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'
 








             reply	other threads:[~2009-12-27 17:29 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-12-27 17:29 Drew Adams [this message]
     [not found] <ww4omqu81j.fsf@fencepost.gnu.org>
2010-01-16 21:21 ` bug#5274: 23.1; doc string of ad-add-advice Chong Yidong

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=CFDCB17E34EC41FEBE68227204FBB4DF@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=5274@debbugs.gnu.org \
    --cc=bug-gnu-emacs@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.