From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#64018: 29.0.91; Improve tree-sitter docs Date: Mon, 12 Jun 2023 18:09:27 +0300 Message-ID: <837cs8yaxk.fsf@gnu.org> References: <878rco22cy.fsf@epfl.ch> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="11031"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 64018@debbugs.gnu.org, casouri@gmail.com To: Basil Contovounesios Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Jun 12 17:10:27 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1q8jBb-0002em-Iy for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 12 Jun 2023 17:10:27 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1q8jBH-00066S-D0; Mon, 12 Jun 2023 11:10:07 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q8jBC-00065a-NJ for bug-gnu-emacs@gnu.org; Mon, 12 Jun 2023 11:10:04 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1q8jBC-0002K0-2c for bug-gnu-emacs@gnu.org; Mon, 12 Jun 2023 11:10:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1q8jBB-0006CS-Q3 for bug-gnu-emacs@gnu.org; Mon, 12 Jun 2023 11:10:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 12 Jun 2023 15:10:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 64018 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 64018-submit@debbugs.gnu.org id=B64018.168658257523783 (code B ref 64018); Mon, 12 Jun 2023 15:10:01 +0000 Original-Received: (at 64018) by debbugs.gnu.org; 12 Jun 2023 15:09:35 +0000 Original-Received: from localhost ([127.0.0.1]:40196 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1q8jAk-0006BV-PX for submit@debbugs.gnu.org; Mon, 12 Jun 2023 11:09:35 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:46112) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1q8jAf-0006BG-Vb for 64018@debbugs.gnu.org; Mon, 12 Jun 2023 11:09:33 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q8jAY-0002Cu-74; Mon, 12 Jun 2023 11:09:23 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=DRbndQrtTBXZjD5GFRWRYDXIfov9qmUgvQWpNKSNQpA=; b=MLrvDI/hgAEx yCXb4NrWvvttyRSPsgUCMPpu5YyRejulm3hRqZXms7U5zRWk6a3VSdhMiIb8k9+gEwWS1lZm5fYc4 1df/e1kFv00bw7gFRjIBhVSlrLjnVZlk2rlKO3AnNam2eY6kasYR8OqMqCrXjs8ThTHkkaLiatWNH RgXonc50h0556MCaDymIb2TSjp66TNTPAR3gNXv7CKG1jINCfKSlsalaWCdCc3o9aurhs7Ka0uuiU aQNt9VebFM6m4sQdIlTKRB1ycqFPcRr4FGt3EXANYny8tFbl5AqONmnmSMiGNm4LcYmxuRmOFK0VW 1PbJSjD5TQqPd2PzRfhjqw==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q8jAO-0001xU-6b; Mon, 12 Jun 2023 11:09:20 -0400 In-Reply-To: <878rco22cy.fsf@epfl.ch> (bug-gnu-emacs@gnu.org) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:263280 Archived-At: > Cc: Yuan Fu > 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" > > 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.