GNU bug report logs - #27764
26.0.50; Argument STARTUP-HOOKS for `ediff-files' undocumented

Previous Next

Full log

Message #11 received at 27764 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Philipp Stephani <p.stephani2 <at> gmail.com>
Cc: 27764 <at> debbugs.gnu.org
Subject: Re: bug#27764: 26.0.50;
 Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Sat, 23 Sep 2017 21:59:48 +0300

> From: Philipp Stephani <p.stephani2 <at> gmail.com>
> Date: Sat, 23 Sep 2017 18:46:57 +0000
> 
> Here's a patch that adds some missing documentation to ediff.el. 

Thanks.

>  ;;;###autoload
>  (defun ediff-buffers (buffer-A buffer-B &optional startup-hooks job-name)
> -  "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B."
> +  "Run Ediff on a pair of buffers, BUFFER-A and BUFFER-B.
> +STARTUP-HOOKS is a list of functions that Emacs calls without
> +arguments after setting up the Ediff buffers.  JOB-NAME is a
> +symbol describing the Ediff job type; it defaults to
> +`ediff-buffers'."

Here and elsewhere where JOB-NAME is mentioned, it would be good to
have a full list of supported symbols, not just the default one.

Otherwise, the patch looks good to me.  Thanks for taking good care of
this.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.