GNU bug report logs - #3598
23.0.94; doc string of frame-root-window

Previous Next

Package: emacs;

Reported by: "Drew Adams" <drew.adams <at> oracle.com>

Date: Wed, 17 Jun 2009 16:50:04 UTC

Severity: minor

Merged with 3599

Done: martin rudalics <rudalics <at> gmx.at>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Lennart Borgman <lennart.borgman <at> gmail.com>
To: Drew Adams <drew.adams <at> oracle.com>, 3598 <at> debbugs.gnu.org
Cc: Eli Zaretskii <eliz <at> gnu.org>
Subject: bug#3598: 23.0.94; doc string of frame-root-window
Date: Thu, 18 Jun 2009 18:47:08 +0200

On Thu, Jun 18, 2009 at 5:17 PM, Drew Adams<drew.adams <at> oracle.com> wrote:
>> > If it is an internal function, then please either do not
>> > give it a doc string or, preferably, give it one that calls
>> > that out explicitly, and please add a
>> > comment explaining why it is internal.
>>
>> I see no reason not to have doc strings for internal functions.
>> Emacs hackers need doc strings from time to time.  Adding "internal
>> use only" to the doc string is the preferred solution.
>
> FWIW, I agree 100%.


And I agree 150%. At least.

In every situation where the semantics of a function may be difficult
to understand it is very important to have the doc string describe it.
Otherwise both the person who programs the function and the user might
be confused.
This bug report was last modified 13 years and 236 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.