From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#27764: 26.0.50; Argument STARTUP-HOOKS for `ediff-files' undocumented Date: Fri, 29 Sep 2017 10:17:49 +0300 Message-ID: <83bmlu9dnm.fsf@gnu.org> References: <83lgl59r6j.fsf@gnu.org> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1506669556 17171 195.159.176.226 (29 Sep 2017 07:19:16 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 29 Sep 2017 07:19:16 +0000 (UTC) Cc: 27764@debbugs.gnu.org To: Philipp Stephani Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Sep 29 09:19:10 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dxpZi-0003dc-K1 for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Sep 2017 09:19:06 +0200 Original-Received: from localhost ([::1]:33969 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dxpZn-0002yN-Ue for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Sep 2017 03:19:11 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34622) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dxpZh-0002yH-Ra for bug-gnu-emacs@gnu.org; Fri, 29 Sep 2017 03:19:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dxpZe-0004Fn-NI for bug-gnu-emacs@gnu.org; Fri, 29 Sep 2017 03:19:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:57031) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dxpZe-0004FX-JR for bug-gnu-emacs@gnu.org; Fri, 29 Sep 2017 03:19:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1dxpZe-00057F-Dx for bug-gnu-emacs@gnu.org; Fri, 29 Sep 2017 03:19:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 29 Sep 2017 07:19:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 27764 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 27764-submit@debbugs.gnu.org id=B27764.150666948819603 (code B ref 27764); Fri, 29 Sep 2017 07:19:02 +0000 Original-Received: (at 27764) by debbugs.gnu.org; 29 Sep 2017 07:18:08 +0000 Original-Received: from localhost ([127.0.0.1]:37479 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dxpYm-000566-8W for submit@debbugs.gnu.org; Fri, 29 Sep 2017 03:18:08 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:43518) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dxpYk-00055c-E9 for 27764@debbugs.gnu.org; Fri, 29 Sep 2017 03:18:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dxpYc-0003gt-0S for 27764@debbugs.gnu.org; Fri, 29 Sep 2017 03:18:01 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:57348) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dxpYb-0003gp-TV; Fri, 29 Sep 2017 03:17:57 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:4917 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1dxpYb-0001AY-AY; Fri, 29 Sep 2017 03:17:57 -0400 In-reply-to: (message from Philipp Stephani on Sun, 24 Sep 2017 08:00:53 +0000) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:137559 Archived-At: > From: Philipp Stephani > Date: Sun, 24 Sep 2017 08:00:53 +0000 > Cc: 27764@debbugs.gnu.org > > > (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. > > I've added some generic text to the docstrings. I have no idea what the full list of supported symbols are and > what the point of this argument is in the first place. Can we have there at least the list of the symbols that are seen in the sources: I see these: ediff-merge-files-with-ancestor, ediff-last-dir-ancestor, ediff-last-dir-C, ediff-buffers, ediff-buffers3, ediff-merge-buffers, ediff-merge-buffers-with-ancestor If this list is too long to be repeated in each doc string, we could have it once, and reference that place from the other do strings. I think either way would be much better than using some generic text. OK? Thanks.