[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#8285: 24.0.50; doc of `imenu-generic-expression' and `imenu--generic
bug#8285: 24.0.50; doc of `imenu-generic-expression' and `imenu--generic-function'
Fri, 18 Mar 2011 20:22:46 +0200
> From: "Drew Adams" <address@hidden>
> Date: Fri, 18 Mar 2011 09:09:47 -0700
> 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
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.