Re: master 305dbc7 2/4: Move description of value to syntax-ppss function.

[Dmitry Gutov <dgutov@yandex.ru>]

On 13.12.2019 14:34, Noam Postavsky wrote:
> On Wed, 30 Oct 2019 at 18:22, Lars Ingebrigtsen <larsi@gnus.org> wrote:
> 
>> Done (with Dmitry's suggestions).  Everybody -- feel free to bikeshed
>> (and change any of the accessor names) before we start using these.
> 
> Is it too late to bikeshed the names? ;)
> I had earlier proposed some slightly shorter ones in
> https://debbugs.gnu.org/32504#51, posting them here as a diff.
> 
> @@ -90,30 +90,30 @@ syntax-propertize-extend-region-functions
>                  (:copier nil)
>                  (:type list))
>     (depth nil :documentation "depth in parens")
> -  (innermost-start
> +  (list-start

Sounds ambiguous: the point is that it's innermost, among possible other 
list starts.

>      nil :documentation
>      "character address of start of innermost containing list; nil if none.")
> -  (last-complete-sexp-start
> +  (last-sexp-start

Same (but, like, in reverse): "complete" is important.

>      nil :documentation
>      "character address of start of last complete sexp terminated.")
>     (string-terminator nil :documentation "\
>   non-nil if inside a string.
>   (it is the character that will terminate the string, or t if the
>   string should be terminated by a generic string delimiter.)")
> -  (comment-nesting nil :documentation "\
> +  (comment nil :documentation "\

Doesn't this name imply some other value? Like a string (comment opener 
or its contents)?

> -  (comment-or-string-start
> +  (context-start
>      nil :documentation
>      "character address of start of comment or string; nil if not in one.")

That kind of implies that strings and comments are the most important 
contexts when parsing a file.

> -  (open-paren-positions
> +  (open-parens
>      nil :documentation
>      "List of positions of currently open parens, outermost first.")
> -  (two-character-syntax nil :documentation "\
> +  (syntax-sequence nil :documentation "\
>   When the last position scanned holds the first character of a
>   (potential) two character construct, the syntax of that position,
>   otherwise nil.  That construct can be a two character comment

These look okay to me.

min-depth too, but, like last-complete-sexp-start, these fields in 
values returned by syntax-ppss are unreliable/undefined, so they won't 
be used in most Lisp programs anyway.