From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Basil Contovounesios via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#64018: 29.0.91; Improve tree-sitter docs Date: Tue, 13 Jun 2023 15:45:03 +0100 Message-ID: <87ilbra0b4.fsf@epfl.ch> References: <878rco22cy.fsf@epfl.ch> <837cs8yaxk.fsf@gnu.org> <87a5x3czkr.fsf@epfl.ch> <83fs6vwkt7.fsf@gnu.org> Reply-To: Basil Contovounesios Mime-Version: 1.0 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="10316"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 64018@debbugs.gnu.org, casouri@gmail.com To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Jun 13 16:46:24 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 1q95Hs-0002To-DO for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 13 Jun 2023 16:46:24 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1q95HY-0002Xb-Is; Tue, 13 Jun 2023 10:46:04 -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 1q95HW-0002Ww-3x for bug-gnu-emacs@gnu.org; Tue, 13 Jun 2023 10:46:02 -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 1q95HV-0004Z5-RA for bug-gnu-emacs@gnu.org; Tue, 13 Jun 2023 10:46:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1q95HV-0001Je-MC for bug-gnu-emacs@gnu.org; Tue, 13 Jun 2023 10:46:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Basil Contovounesios Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 13 Jun 2023 14:46: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.16866675134992 (code B ref 64018); Tue, 13 Jun 2023 14:46:01 +0000 Original-Received: (at 64018) by debbugs.gnu.org; 13 Jun 2023 14:45:13 +0000 Original-Received: from localhost ([127.0.0.1]:42693 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1q95Gj-0001IS-AL for submit@debbugs.gnu.org; Tue, 13 Jun 2023 10:45:13 -0400 Original-Received: from mail-wm1-f47.google.com ([209.85.128.47]:44108) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1q95Gh-0001ID-9T for 64018@debbugs.gnu.org; Tue, 13 Jun 2023 10:45:11 -0400 Original-Received: by mail-wm1-f47.google.com with SMTP id 5b1f17b1804b1-3f8cc04c278so5825705e9.0 for <64018@debbugs.gnu.org>; Tue, 13 Jun 2023 07:45:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tcd.ie; s=google21; t=1686667505; x=1689259505; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=ql5+PP+StiERBjBE6nJi48ULrDPjSYtqnh4ouJegKkE=; b=LcHqYHT8veuwJmDEgjKYTXU9/8AvS19Nav2gbQdbLWN8awSBTYgCRUA7KL+2+xXhPe nst+L6MxS0IvOHQSrWFZDyBxeqwCmPCSWoXFOCTCvGxrDSyVJY81dsmfoPjYQGuSmknq cSs0ZvjjVeRyvqVnBV31CKNNMAWNAvZgKdqYSjQ38Xzl2c4hqAL0vP13RZLy0IZv+8xq cDBdlJHhnm2dsiUUxLaUvntvX+e+WahQsw/VTLkVZNIWCTGLqquo4c5zhBeVqfpjsBMl p5RAbKE5TmlMJEajRtzslP9x2Ebyzs2mS5oFpCnU5kss0Mgu9749UJhgim5esmeh2rTP G2Hw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1686667505; x=1689259505; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=ql5+PP+StiERBjBE6nJi48ULrDPjSYtqnh4ouJegKkE=; b=bOZLlI9jYOgrCiSXBneTlTIluR07NdMUNRk2XHQ+q8W9C2Pxa53rlB/wX07wAfF5ja 28DuW0BIPvoIEFQnPqEEcS+3cOWvjpkuWlh9h5kLqszpWKhXjFZ9uYW5jJH3wszhgrre RpAl5k60z7+8xl/Bp0SF96XNdldHnQrRpUX3dDtaC4Y8fW1xVrtEwG4lW/GbSIp3azUY OhTJ3i9wa3FHvvElhifFuz7l/yjC/9SKOHCjJnlsyRZQU5ZfV/BqC2kEeKYQpGs5WIlC HRzjL6BmNnlnVX78SZtj6u92nRoIYKtBBYUOQDXsH8cVUlRREtrgtOX7CWGNKP3vHIXq lCyg== X-Gm-Message-State: AC+VfDxehzaM50lM3InbPS9gf8OX5WmsmuK5VdsAN135urP+NeYR25wG Ha+auoswdNJgA7qQ8glqHZ2KEw== X-Google-Smtp-Source: ACHHUZ4diCj6TNRZNrKslJQKa1pOAcjZSFha2MiO8scsT2O2ePETULBsq88PgJni6Hu/cMg7rXWsaw== X-Received: by 2002:a7b:c4d5:0:b0:3f6:13e1:16b7 with SMTP id g21-20020a7bc4d5000000b003f613e116b7mr8198702wmk.28.1686667505506; Tue, 13 Jun 2023 07:45:05 -0700 (PDT) Original-Received: from localhost ([217.173.96.166]) by smtp.gmail.com with ESMTPSA id v5-20020a05600c214500b003f819faff25sm7367906wml.13.2023.06.13.07.45.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 13 Jun 2023 07:45:05 -0700 (PDT) In-Reply-To: <83fs6vwkt7.fsf@gnu.org> (Eli Zaretskii's message of "Tue, 13 Jun 2023 09:31:00 -0400") 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:263326 Archived-At: 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 =E2=80=98:embed=E2=80=99 keyword speci= fies the ^^^^^^^^ embedded language, and the =E2=80=98:host=E2=80=99 keyword specified t= he host language. [...] If QUERY is a function, it doesn=E2=80=99t 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? Thanks, --=20 Basil