GNU bug report logs - #8624
24.0.50; `font-lock-default-fontify-buffer'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 8624 in the body.
You can then email your comments to 8624 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.0.50; `font-lock-default-fontify-buffer'
Date: Thu, 5 May 2011 15:05:48 -0700

This function is the default value of several important variables, all
of which are documented in (elisp) Other Font Lock Variables.  All this
doc does, in essence, is say "see `font-lock-default-fontify-buffer'".
 
But of course there is *NO* doc for `font-lock-default-fontify-buffer',
not even a doc string.  Please fix this.  Likewise
`font-lock-default-unfontify-buffer'.  It should be a no-brainer that
pretty much any function that has "default" as part of its name needs a
doc string.
 

In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-04-25 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/imagesupport/include'
 

Message #8 received at 8624 <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <8624 <at> debbugs.gnu.org>
Subject: RE: bug#8624: 24.0.50; `font-lock-default-fontify-buffer'
Date: Thu, 5 May 2011 15:13:53 -0700

And obviously `font-lock-default-(un)fontify-region', etc.

Message #11 received at 8624 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8624 <at> debbugs.gnu.org
Subject: Re: 24.0.50; `font-lock-default-fontify-buffer'
Date: Fri, 15 Jul 2011 15:23:47 +0200

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

> This function is the default value of several important variables, all
> of which are documented in (elisp) Other Font Lock Variables.  All this
> doc does, in essence, is say "see `font-lock-default-fontify-buffer'".
>
> But of course there is *NO* doc for `font-lock-default-fontify-buffer',
> not even a doc string.  Please fix this.  Likewise
> `font-lock-default-unfontify-buffer'.  It should be a no-brainer that
> pretty much any function that has "default" as part of its name needs a
> doc string.

What would you imagine these doc strings would say?  "(un)fontify the
region according to the default font-lock rules; see the manual for
details"?

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Message #14 received at 8624 <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi <at> gnus.org>
Cc: 8624 <at> debbugs.gnu.org
Subject: RE: 24.0.50; `font-lock-default-fontify-buffer'
Date: Fri, 15 Jul 2011 07:18:16 -0700

> What would you imagine these doc strings would say?  "(un)fontify the
> region according to the default font-lock rules; see the manual for
> details"?

If that's what these functions do, then yes.  But only if the manual actually
explains things, i.e., provides the details.  And wrt putting such a sentence in
the manual (not just in the doc strings), it needs to cross-reference the
precise node or nodes where this is explained.

This should be a no-brainer, at least in terms of need if not in terms of the
explanations to add.  Today we in effect refer people to non-existent doc.  We
do not explain this today.

Message #17 received at 8624 <at> debbugs.gnu.org (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8624 <at> debbugs.gnu.org
Subject: Re: bug#8624: 24.0.50; `font-lock-default-fontify-buffer'
Date: Sat, 20 Aug 2011 23:02:43 -0400

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

> This function is the default value of several important variables, all
> of which are documented in (elisp) Other Font Lock Variables.  All this
> doc does, in essence, is say "see `font-lock-default-fontify-buffer'".
>
> But of course there is *NO* doc for `font-lock-default-fontify-buffer',
> not even a doc string.  Please fix this.  Likewise
> `font-lock-default-unfontify-buffer'.  It should be a no-brainer that
> pretty much any function that has "default" as part of its name needs a
> doc string.

Sure; fixed.

Previous Next

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