Subject: Re: 24.0.50; doc strings in syntax.el

From: Lars Magne Ingebrigtsen <[email-masked]>
Date: Fri, 15 Jul 2011 15:53:21 +0200

"Drew Adams" <[email-masked]> writes:

> 1. Everywhere in syntax.el, please change "upto" to "up to".
> (Not English.)

Two instances fixed.

> 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.

Do you have a suggestion for descriptions for these things?

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