Eli Zaretskii <
eliz@gnu.org> schrieb am Sa., 23. Sep. 2017 um 21:00 Uhr:
> From: Philipp Stephani <p.stephani2@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.
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.
0001-Ediff-add-some-missing-documentation.txt