* bug#8624: 24.0.50; `font-lock-default-fontify-buffer'
@ 2011-05-05 22:05 Drew Adams
2011-05-05 22:13 ` Drew Adams
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Drew Adams @ 2011-05-05 22:05 UTC (permalink / raw)
To: 8624
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'
^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#8624: 24.0.50; `font-lock-default-fontify-buffer'
2011-05-05 22:05 bug#8624: 24.0.50; `font-lock-default-fontify-buffer' Drew Adams
@ 2011-05-05 22:13 ` Drew Adams
2011-07-15 13:23 ` Lars Magne Ingebrigtsen
2011-08-21 3:02 ` Chong Yidong
2 siblings, 0 replies; 5+ messages in thread
From: Drew Adams @ 2011-05-05 22:13 UTC (permalink / raw)
To: 8624
And obviously `font-lock-default-(un)fontify-region', etc.
^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#8624: 24.0.50; `font-lock-default-fontify-buffer'
2011-05-05 22:05 bug#8624: 24.0.50; `font-lock-default-fontify-buffer' Drew Adams
2011-05-05 22:13 ` Drew Adams
@ 2011-07-15 13:23 ` Lars Magne Ingebrigtsen
2011-07-15 14:18 ` Drew Adams
2011-08-21 3:02 ` Chong Yidong
2 siblings, 1 reply; 5+ messages in thread
From: Lars Magne Ingebrigtsen @ 2011-07-15 13:23 UTC (permalink / raw)
To: Drew Adams; +Cc: 8624
"Drew Adams" <drew.adams@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/
^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#8624: 24.0.50; `font-lock-default-fontify-buffer'
2011-07-15 13:23 ` Lars Magne Ingebrigtsen
@ 2011-07-15 14:18 ` Drew Adams
0 siblings, 0 replies; 5+ messages in thread
From: Drew Adams @ 2011-07-15 14:18 UTC (permalink / raw)
To: 'Lars Magne Ingebrigtsen'; +Cc: 8624
> 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.
^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#8624: 24.0.50; `font-lock-default-fontify-buffer'
2011-05-05 22:05 bug#8624: 24.0.50; `font-lock-default-fontify-buffer' Drew Adams
2011-05-05 22:13 ` Drew Adams
2011-07-15 13:23 ` Lars Magne Ingebrigtsen
@ 2011-08-21 3:02 ` Chong Yidong
2 siblings, 0 replies; 5+ messages in thread
From: Chong Yidong @ 2011-08-21 3:02 UTC (permalink / raw)
To: Drew Adams; +Cc: 8624
"Drew Adams" <drew.adams@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.
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2011-08-21 3:02 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2011-05-05 22:05 bug#8624: 24.0.50; `font-lock-default-fontify-buffer' Drew Adams
2011-05-05 22:13 ` Drew Adams
2011-07-15 13:23 ` Lars Magne Ingebrigtsen
2011-07-15 14:18 ` Drew Adams
2011-08-21 3:02 ` Chong Yidong
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).