From: Eli Zaretskii <eliz@gnu.org>
To: Basil Contovounesios <contovob@tcd.ie>
Cc: 64018@debbugs.gnu.org, casouri@gmail.com
Subject: bug#64018: 29.0.91; Improve tree-sitter docs
Date: Tue, 13 Jun 2023 18:53:15 +0300 [thread overview]
Message-ID: <838rcnwe8k.fsf@gnu.org> (raw)
In-Reply-To: <87ilbra0b4.fsf@epfl.ch> (message from Basil Contovounesios on Tue, 13 Jun 2023 15:45:03 +0100)
> From: Basil Contovounesios <contovob@tcd.ie>
> Cc: 64018@debbugs.gnu.org, casouri@gmail.com
> Date: Tue, 13 Jun 2023 15:45:03 +0100
>
> Eli Zaretskii [2023-06-13 09:31 -0400] wrote:
>
> > But on second thought: why do you need the colon at all? What does it
> > signifiy? If you must say that KEYWORD begins with a colon, just say
> > that (although it's pretty clear), or maybe show an example.
>
> I added a colon in this single instance for consistency with subsequent
> paragraphs of the same function definition:
>
> It takes a series of QUERY-SPECs, where each QUERY-SPEC is a QUERY
> preceded by zero or more KEYWORD/VALUE pairs. Each QUERY is a
> ^^^^^^^
> tree-sitter query in either the string, s-expression or compiled
> form, or a function.
>
> If QUERY is a tree-sitter query, it should be preceded by two
> :KEYWORD/VALUE pairs, where the ‘:embed’ keyword specifies the
> ^^^^^^^^
> embedded language, and the ‘:host’ keyword specified the host
> language.
>
> [...]
>
> If QUERY is a function, it doesn’t need any :KEYWORD and VALUE
> ^^^^^^^^
> pair. It should be a function that takes 2 arguments, START and
> END, and sets the ranges for parsers in the current buffer in the
> region between START and END. It is fine for this function to set
> ranges in a larger region that encompasses the region between START
> and END.
>
> The same @var{:keyword}/@var{value} pattern also appears a couple of
> times in the related '(elisp) Parser-based Font Lock'.
>
> I don't mind what we go with, so long as it's used consistently across
> paragraphs of the same definition. Which markup/wording do you prefer?
I think the colons should removed.
next prev parent reply other threads:[~2023-06-13 15:53 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-12 14:15 bug#64018: 29.0.91; Improve tree-sitter docs Basil Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-06-12 15:09 ` Eli Zaretskii
2023-06-13 9:17 ` Yuan Fu
2023-06-13 12:32 ` Basil Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-06-13 13:31 ` Eli Zaretskii
2023-06-13 14:45 ` Basil Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-06-13 15:53 ` Eli Zaretskii [this message]
2023-06-13 16:26 ` Basil Contovounesios via Bug reports for GNU Emacs, the Swiss army knife of text editors
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=838rcnwe8k.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=64018@debbugs.gnu.org \
--cc=casouri@gmail.com \
--cc=contovob@tcd.ie \
/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 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).