* bug#16308: 24.3.50; doc of `font-lock-keywords'
@ 2013-12-31 17:20 Drew Adams
2014-02-08 2:50 ` Lars Ingebrigtsen
0 siblings, 1 reply; 4+ messages in thread
From: Drew Adams @ 2013-12-31 17:20 UTC (permalink / raw)
To: 16308
The description in the Elisp manual, which is our reference, should be
at least as complete as the doc string. It is not. In particular, it
does not describe the structure of the value correctly. It does not
mention the compiled form, with car `t' etc.
The doc string is far more complete. If anything, it should be the
other way around. But preferably, both doc string and manual (node
`Search-based Fontification', currently) should each be complete and
correct.
[BTW, the name of that node should use "Search-Based", not "Search-based".]
In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
of 2013-12-27 on ODIEONE
Bzr revision: 115778 rgm@gnu.org-20131228000456-1797o8z6veuyozs0
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
`configure --prefix=/c/Devel/emacs/binary --enable-checking=yes,glyphs
'CFLAGS=-O0 -g3' LDFLAGS=-Lc:/Devel/emacs/lib
CPPFLAGS=-Ic:/Devel/emacs/include'
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#16308: 24.3.50; doc of `font-lock-keywords'
2013-12-31 17:20 bug#16308: 24.3.50; doc of `font-lock-keywords' Drew Adams
@ 2014-02-08 2:50 ` Lars Ingebrigtsen
2014-02-08 3:21 ` Drew Adams
0 siblings, 1 reply; 4+ messages in thread
From: Lars Ingebrigtsen @ 2014-02-08 2:50 UTC (permalink / raw)
To: Drew Adams; +Cc: 16308
Drew Adams <drew.adams@oracle.com> writes:
> The description in the Elisp manual, which is our reference, should be
> at least as complete as the doc string. It is not. In particular, it
> does not describe the structure of the value correctly. It does not
> mention the compiled form, with car `t' etc.
>
> The doc string is far more complete. If anything, it should be the
> other way around. But preferably, both doc string and manual (node
> `Search-based Fontification', currently) should each be complete and
> correct.
No, I think the information about the compiled form isn't particularly
relevant for people who are composing the keywords, while it is relevant
for people who examine the variable, so it's fine the way it is.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog http://lars.ingebrigtsen.no/
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#16308: 24.3.50; doc of `font-lock-keywords'
2014-02-08 2:50 ` Lars Ingebrigtsen
@ 2014-02-08 3:21 ` Drew Adams
2014-02-08 5:02 ` Stefan Monnier
0 siblings, 1 reply; 4+ messages in thread
From: Drew Adams @ 2014-02-08 3:21 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: 16308
> No, I think the information about the compiled form isn't
> particularly relevant for people who are composing the keywords,
> while it is relevant for people who examine the variable, so
> it's fine the way it is.
Well you think wrong, then.
The Elisp manual is our _reference_. The info there about
`font-lock-keywords' needs to be complete. It is not at all
there only for "people who are composing the keywords".
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2014-02-08 5:02 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-12-31 17:20 bug#16308: 24.3.50; doc of `font-lock-keywords' Drew Adams
2014-02-08 2:50 ` Lars Ingebrigtsen
2014-02-08 3:21 ` Drew Adams
2014-02-08 5:02 ` Stefan Monnier
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).