From: "Drew Adams" <drew.adams@oracle.com>
To: 8693@debbugs.gnu.org
Subject: bug#8693: 24.0.50; doc strings in syntax.el
Date: Wed, 18 May 2011 09:14:50 -0700 [thread overview]
Message-ID: <F4FC8AD7A8434CF8AF03A1070BC5AF48@us.oracle.com> (raw)
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'
next reply other threads:[~2011-05-18 16:14 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-05-18 16:14 Drew Adams [this message]
2011-05-18 16:28 ` bug#8693: 24.0.50; doc strings in syntax.el Drew Adams
2011-05-18 22:10 ` Stefan Monnier
2011-05-18 22:46 ` Drew Adams
2011-07-15 13:53 ` Lars Magne Ingebrigtsen
2011-07-15 15:09 ` Drew Adams
2016-04-28 10:59 ` Lars Ingebrigtsen
2016-04-28 13:55 ` Drew Adams
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=F4FC8AD7A8434CF8AF03A1070BC5AF48@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=8693@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.