From: Yuan Fu <casouri@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Basil Contovounesios <contovob@tcd.ie>, 64018@debbugs.gnu.org
Subject: bug#64018: 29.0.91; Improve tree-sitter docs
Date: Tue, 13 Jun 2023 02:17:21 -0700 [thread overview]
Message-ID: <B89C977E-3DA5-44AC-9A42-69CB85D3192F@gmail.com> (raw)
In-Reply-To: <837cs8yaxk.fsf@gnu.org>
> On Jun 12, 2023, at 8:09 AM, Eli Zaretskii <eliz@gnu.org> wrote:
>
>> Cc: Yuan Fu <casouri@gmail.com>
>> Date: Mon, 12 Jun 2023 15:15:41 +0100
>> From: Basil Contovounesios via "Bug reports for GNU Emacs,
>> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>>
>> While reading through the excellent tree-sitter documentation I
>> collected some potential improvements against emacs-29, either for
>> typos, to clarify wording, or fix up some probable errors like duplicate
>> instances of treesit-defun-type-regexp and parent-bol.
>>
>> WDYT?
>
> Thanks for this proofreading. Everything LGTM, with a couple of minor
> exceptions:
>
>> This function raises the @code{treesit-query-error} error if
>> -@var{query} is malformed. The signal data contains a description of
>> +@var{query} is malformed. The signal data contain a description of
>
> I think "data contains" looks better. In general, "data" is used as
> singular in this and other similar cases. (There are other such
> changes in the patch, which I'd rather drop.)
>
>> It takes a series of @var{query-spec}s, where each @var{query-spec} is
>> -a @var{query} preceded by zero or more @var{keyword}/@var{value}
>> +a @var{query} preceded by zero or more @var{:keyword}/@var{value}
> ^^^^^^^^^^^^^^
> This should be @code{:@var{keyword}} instead. That is, the colon is
> not part of the meta-syntactic variable, it is a literal character.
>
>> For example, @code{python-mode} sets this variable to a regexp that
>> -matches either @code{"function_definition"} or @code{"class_definition"}.
>> +matches either @code{function_definition} or @code{class_definition}.
>
> It is better to use @samp here, not @code. That way, you get the
> quotes in the printed output.
Thanks a bunch! I don’t have anything to add.
Yuan
next prev parent reply other threads:[~2023-06-13 9:17 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 [this message]
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
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=B89C977E-3DA5-44AC-9A42-69CB85D3192F@gmail.com \
--to=casouri@gmail.com \
--cc=64018@debbugs.gnu.org \
--cc=contovob@tcd.ie \
--cc=eliz@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.