From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 8285@debbugs.gnu.org
Subject: bug#8285: 24.0.50; doc of `imenu-generic-expression' and `imenu--generic-function'
Date: Fri, 18 Mar 2011 20:22:46 +0200 [thread overview]
Message-ID: <838vwcs2yx.fsf@gnu.org> (raw)
In-Reply-To: <6CAA58C0292943D68651BC3DB49A62C0@us.oracle.com>
> From: "Drew Adams" <drew.adams@oracle.com>
> Date: Fri, 18 Mar 2011 09:09:47 -0700
> Cc:
>
> If you don't understand the problem, change these names to UU, VV,
> WW, XX, YY, and ZZ, and see if you understand the doc.
This argument is bogus: names of symbols can and should bear
significant semantic information that helps to understand their roles,
and if that information is descriptive enough, there's no need for any
further definitions.
As an extreme example, consider:
(defun call-func (function &rest arguments)
"Call FUNCTION with ARGUMENTS."
I see no need to explain the arguments in this example.
I'm not saying that the doc string in question could not use some
improvement. But since imenu is about creating indices of functions
in a program source file, at least FUNCTION and ARGUMENTS do not need
any further explanations, IMO.
next prev parent reply other threads:[~2011-03-18 18:22 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-03-18 16:09 bug#8285: 24.0.50; doc of `imenu-generic-expression' and `imenu--generic-function' Drew Adams
2011-03-18 16:41 ` Drew Adams
2011-03-18 18:22 ` Eli Zaretskii [this message]
2011-03-18 18:56 ` Drew Adams
2021-08-26 15:49 ` Lars Ingebrigtsen
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=838vwcs2yx.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=8285@debbugs.gnu.org \
--cc=drew.adams@oracle.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 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).