From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Yuan Fu Newsgroups: gmane.emacs.bugs Subject: bug#64018: 29.0.91; Improve tree-sitter docs Date: Tue, 13 Jun 2023 02:17:21 -0700 Message-ID: References: <878rco22cy.fsf@epfl.ch> <837cs8yaxk.fsf@gnu.org> Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3731.600.7\)) Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="3811"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Basil Contovounesios , 64018@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Jun 13 11:19:28 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 1q90BT-0000lo-FL for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 13 Jun 2023 11:19:27 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1q90B8-0008AX-2t; Tue, 13 Jun 2023 05:19:06 -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 1q90B5-0008A8-BZ for bug-gnu-emacs@gnu.org; Tue, 13 Jun 2023 05:19: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 1q90B5-0002sc-37 for bug-gnu-emacs@gnu.org; Tue, 13 Jun 2023 05:19:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1q90B4-0003hb-6q for bug-gnu-emacs@gnu.org; Tue, 13 Jun 2023 05:19:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Yuan Fu Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 13 Jun 2023 09:19:02 +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.168664790914185 (code B ref 64018); Tue, 13 Jun 2023 09:19:02 +0000 Original-Received: (at 64018) by debbugs.gnu.org; 13 Jun 2023 09:18:29 +0000 Original-Received: from localhost ([127.0.0.1]:41307 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1q90AW-0003gj-Pm for submit@debbugs.gnu.org; Tue, 13 Jun 2023 05:18:29 -0400 Original-Received: from mail-pl1-f180.google.com ([209.85.214.180]:42224) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1q90AR-0003gL-5b for 64018@debbugs.gnu.org; Tue, 13 Jun 2023 05:18:27 -0400 Original-Received: by mail-pl1-f180.google.com with SMTP id d9443c01a7336-1b3be39e666so17425565ad.0 for <64018@debbugs.gnu.org>; Tue, 13 Jun 2023 02:18:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1686647855; x=1689239855; h=to:references:message-id:content-transfer-encoding:cc:date :in-reply-to:from:subject:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=NG/Wdy8NqyjRpI4ovMvsKyH0rbRak+aCQ8gprM3V7P0=; b=UkaGK+I4NU4PC8f1P+tcczEpTZ221v11RiYVrMpeTkbr1/twcs1GZYsoW6AyfonBcc /2p8SueLpaadiWAsc50HFI86ey4fHI5Jwo0HIQfXlhrw2uSttZQeKyXQZh6BQssMYCPR 7vBkccABHWMo82Kt2ZmKm9qj6q5w0cwxGh8njOqokljiAGZzoHsz0YdiwWC1S+i5DkL2 YghK4xC94kJaxupLClePORx968Ojjd5C2xZnmtJjxAxsvsNSX/T8MwiMoDz7lzqVGuIM kXBlFK3SQmT/s7XYzehUPkD97PLdpDHwHk1z/FVpT8Orz6iASWSMbFnhkXtoZHr75pIs Zc7Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686647855; x=1689239855; h=to:references:message-id:content-transfer-encoding:cc:date :in-reply-to:from:subject:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=NG/Wdy8NqyjRpI4ovMvsKyH0rbRak+aCQ8gprM3V7P0=; b=V8ya3QtKsHAKodxY/m+4wqam7tyXJW+nJgKIE9UK3BLenk9OGqctVVLPDfbMi0E90V aqurLCKVzpPSgeqETQ2jSnDw5j6vecSo+P9HZ9tbpqZO9R90k4e3+3EMgnGrILw+tlEV OZeF85G87dePmznacgMEFsClnT0QMjK3O3pGCXeZ1EuclhvSbRyUzhssCyuhUBmIkNn0 Q4rrwaCqjSwe82o93SjjtgUzjWMvrZpdCHgeKjxkll2XtTu//adJhundqR0UV1D4vZ7I GS3rMzzPbSai5PG4a51CePH2xGdva1M5vIJoxuH0oC9wtl7ZtWVS65CLy4SEEKgkQoYt WlfA== X-Gm-Message-State: AC+VfDwsOSHy0+WVIKKKZ8/y/Hwa+OlRhwAqEShd+FSbej8p4nDHQrHw /0L4DeT1FwjR5X+e7rDMvMw= X-Google-Smtp-Source: ACHHUZ7mX/AVjNclDxUNAAlv/awEjsMc5MPQpLTKFX4BXMhe/8YUJxNeJ/hbxnP5Js3xax9f1j8Oow== X-Received: by 2002:a17:902:d2c4:b0:1b1:94a8:ab2d with SMTP id n4-20020a170902d2c400b001b194a8ab2dmr11521531plc.29.1686647854200; Tue, 13 Jun 2023 02:17:34 -0700 (PDT) Original-Received: from smtpclient.apple (cpe-172-117-161-177.socal.res.rr.com. [172.117.161.177]) by smtp.gmail.com with ESMTPSA id ix4-20020a170902f80400b001b3d20ef257sm3268322plb.97.2023.06.13.02.17.32 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Tue, 13 Jun 2023 02:17:33 -0700 (PDT) In-Reply-To: <837cs8yaxk.fsf@gnu.org> X-Mailer: Apple Mail (2.3731.600.7) 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:263307 Archived-At: > On Jun 12, 2023, at 8:09 AM, Eli Zaretskii wrote: >=20 >> 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" >>=20 >> 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. >>=20 >> WDYT? >=20 > Thanks for this proofreading. Everything LGTM, with a couple of minor > exceptions: >=20 >> 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 >=20 > 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.) >=20 >> 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. >=20 >> 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}. >=20 > It is better to use @samp here, not @code. That way, you get the > quotes in the printed output. Thanks a bunch! I don=E2=80=99t have anything to add. Yuan=