what makes read it? [Re: shell completion documentation]

From:

Ilya N. Golubev

Subject:

what makes read it? [Re: shell completion documentation]

Date:

Wed, 20 Dec 2006 23:59:33 +0300

User-agent:

Gnus/5.1007 (Gnus v5.10.7) XEmacs/21.4.20 (linux)

> People normally read the comments in the vicinity of the code they are
> working on.
Remember, the case is that they feel that bug report (combined with
package documentation) is incomplete. So most likely they will not
look at code at all. Even if they do, what will be the <vicinity of
the code they are working on>? Most likely just the place found by
`find-function', far from beginning of the file.
So the issue
What will make maintainers read it before sending (unnecessary)
questions to users?
remains. It appears that at least a reference in manual is necessary.