all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Glenn Morris <rgm@gnu.org>
To: Philipp Stephani <p.stephani2@gmail.com>
Cc: 24675@debbugs.gnu.org
Subject: bug#24675: 26.0.50; Misleading suggestion in Ediff Info manual
Date: Tue, 13 Dec 2016 13:03:32 -0500	[thread overview]
Message-ID: <tcinqn3dvv.fsf@fencepost.gnu.org> (raw)
In-Reply-To: <wvr4eg3l4l6d.fsf@a.muc.corp.google.com> (Philipp Stephani's message of "Wed, 12 Oct 2016 17:54:50 +0200")

Philipp Stephani wrote:

> The Ediff Info manual, in section 7.1 "Hooks", says:
>
> 'ediff-cleanup-hook'
>      This hook is run just before 'ediff-quit-hook'.  This is a good
>      place to do various cleanups, such as deleting the variant buffers.
>      Ediff provides a function, 'ediff-janitor', as one such possible
>      hook, which you can add to 'ediff-cleanup-hook' with 'add-hook'.
>
> However, ediff-cleanup-hook is a normal hook, and ediff-janitor is a
> function taking two required arguments, so it cannot be added to
> ediff-cleanup-hook.  The manual should e.g. state that a lambda wrapping
> ediff-janitor can be added to ediff-cleanup-hook, but not ediff-janitor
> itself.

It seems the doc hasn't been updated in the past 14 years.
Before 50a07e1, there was a single optional argument.
You might be one of the few users of this functionality, so maybe you
would like to fix the doc yourself? (Making the arguments optional is
an additional possibility?)

Since the use of lambda for hooks is basic (eg documented in the
"Hooks" section of the manual), personally I don't see a need to
mention it here or in other places that refer to normal hook uses.






  reply	other threads:[~2016-12-13 18:03 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-12 15:54 bug#24675: 26.0.50; Misleading suggestion in Ediff Info manual Philipp Stephani
2016-12-13 18:03 ` Glenn Morris [this message]
2016-12-18 21:25   ` Philipp Stephani
2016-12-23 18:30     ` Philipp Stephani

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=tcinqn3dvv.fsf@fencepost.gnu.org \
    --to=rgm@gnu.org \
    --cc=24675@debbugs.gnu.org \
    --cc=p.stephani2@gmail.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 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.