GNU bug report logs - #8693
24.0.50; doc strings in syntax.el

Previous Next

Full log

View this message in rfc822 format

From: "Drew Adams" <drew.adams <at> oracle.com>
To: 8693 <at> debbugs.gnu.org
Subject: bug#8693: 24.0.50; doc strings in syntax.el
Date: Wed, 18 May 2011 09:14:50 -0700

1. Everywhere in syntax.el, please change "upto" to "up to".
(Not English.)
 
2. In doc strings of `syntax-propertize-function' and
`syntax-propertize-extend-region-functions': Please describe
START and END: their meanings and possible values (type).
Likewise NEW-START and NEW-END.
 
3. IN doc string of `syntax-propertize-rules':
"if SYNTAX has the form (prog1 EXP . EXPS) then the value
 returned by EXP will be applied to the buffer before running
 EXPS and if EXP is a string it is also converted with
 `string-to-syntax'."
Need descriptions of what EXP and EXPs are: meanings and possible values
(types).
 
4. Doc string of `syntax-propertize-via-font-lock':
"Propertize for syntax in START..END using font-lock syntax..."
There are no parameters START, END.  Please describe them and
relate them to the function.
 
5. Doc string of `syntax-propertize': It would be clearer if POS were
described (e.g. as a buffer position).  Same thing elsewhere that the meaning
might not be obvious.  (Calling it POSITION would pretty much obviate the need
for a description.)
 
6. Doc string of `syntax-ppss-cache': Describe POS and PPSS.
 
7. Doc string of `syntax-ppss-last': Describe LAST-POS and LAST-PPSS.
 
8. Doc string of `syntax-ppss-flush-cache': Describe parameter IGNORED.
 
 
In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-05-16 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'
 

Previous Next

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