From: Eli Zaretskii <eliz@gnu.org>
To: Hong Xu <hong@topbug.net>
Cc: larsi@gnus.org, 37538@debbugs.gnu.org
Subject: bug#37538: [PATCH] Add docstring for `tags-complete-tags-table-file'.
Date: Wed, 09 Oct 2019 11:09:16 +0300 [thread overview]
Message-ID: <83a7aawdar.fsf@gnu.org> (raw)
In-Reply-To: <663aaf32-97c4-0723-1a30-a644938bd21f@topbug.net> (message from Hong Xu on Tue, 8 Oct 2019 23:39:08 -0700)
> Cc: Eli Zaretskii <eliz@gnu.org>, 37538@debbugs.gnu.org
> From: Hong Xu <hong@topbug.net>
> Date: Tue, 8 Oct 2019 23:39:08 -0700
>
> On 10/8/19 9:21 AM, Lars Ingebrigtsen wrote:
> >
> > The problem is that `(elisp) Programmed Completion' (at least in Emacs
> > 27) doesn't mention a WHAT parameter at all, so it's unclear what this
> > refers to.
>
> How about the following change?
I don't see how it solves the problem, sorry. It attempts to assign
some significance to the ordinal number of the argument WHAT, in the
hope that the reader will be able to connect the dots. But a good
documentation should not leave the dots unconnected, it should spell
them out, ideally in one place.
I actually don't understand why we would like to send the reader to
the manual, instead of describing the effects of WHAT in the doc
string. Can we just say it right there?
Thanks.
next prev parent reply other threads:[~2019-10-09 8:09 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-28 7:59 bug#37538: [PATCH] Add docstring for `tags-complete-tags-table-file' Hong Xu
2019-09-28 8:11 ` Eli Zaretskii
2019-09-28 18:40 ` Hong Xu
2019-10-07 4:13 ` Lars Ingebrigtsen
2019-10-07 16:18 ` Eli Zaretskii
2019-10-07 17:27 ` Hong Xu
2019-10-08 16:21 ` Lars Ingebrigtsen
2019-10-09 6:39 ` Hong Xu
2019-10-09 8:09 ` Eli Zaretskii [this message]
2019-10-09 22:58 ` Hong Xu
2019-10-10 7:49 ` Eli Zaretskii
2019-10-12 0:48 ` Hong Xu
2019-10-12 9:04 ` Eli Zaretskii
2019-10-12 18:46 ` Hong Xu
2019-10-12 18:57 ` Eli Zaretskii
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83a7aawdar.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=37538@debbugs.gnu.org \
--cc=hong@topbug.net \
--cc=larsi@gnus.org \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).