From: Eli Zaretskii <eliz@gnu.org>
To: Philipp Stephani <p.stephani2@gmail.com>
Cc: 27764@debbugs.gnu.org
Subject: bug#27764: 26.0.50; Argument STARTUP-HOOKS for `ediff-files' undocumented
Date: Fri, 29 Sep 2017 10:17:49 +0300 [thread overview]
Message-ID: <83bmlu9dnm.fsf@gnu.org> (raw)
In-Reply-To: <CAArVCkRC4o35H38arC6F2JFus8TsDNeFpVKjnzrqonESNPL9Dg@mail.gmail.com> (message from Philipp Stephani on Sun, 24 Sep 2017 08:00:53 +0000)
> From: Philipp Stephani <p.stephani2@gmail.com>
> 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.
next prev parent reply other threads:[~2017-09-29 7:17 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-19 9:20 bug#27764: 26.0.50; Argument STARTUP-HOOKS for `ediff-files' undocumented Philipp Stephani
2017-09-23 18:46 ` Philipp Stephani
2017-09-23 18:59 ` Eli Zaretskii
2017-09-24 8:00 ` Philipp Stephani
2017-09-29 7:17 ` Eli Zaretskii [this message]
2017-11-05 16:29 ` Philipp Stephani
2017-11-05 16:51 ` Eli Zaretskii
2017-11-05 17:54 ` 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=83bmlu9dnm.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=27764@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.