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

Previous Next

Full log

Message #30 received at 3598 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>, 3598 <at> debbugs.gnu.org
Cc: rudalics <at> gmx.at
Subject: Re: bug#3598: 23.0.94; doc string of frame-root-window
Date: Thu, 18 Jun 2009 11:13:52 -0400

> From: "Drew Adams" <drew.adams <at> oracle.com>
> Date: Thu, 18 Jun 2009 07:05:11 -0700
> Cc: 
> Reply-To: Drew Adams <drew.adams <at> oracle.com>, 3598 <at> emacsbugs.donarmstrong.com
> 
> 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.

Previous Next

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