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.devel Subject: Re: Writing manuals Date: Sat, 4 Sep 2021 08:48:36 -0700 Message-ID: References: <83lf4x1kme.fsf@gnu.org> <83k0kh1j84.fsf@gnu.org> <83tuj0x09l.fsf@gnu.org> Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.120.0.1.13\)) 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="10712"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Sep 04 17:50:01 2021 Return-path: Envelope-to: ged-emacs-devel@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 1mMXvc-0002YU-Fj for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Sep 2021 17:50:00 +0200 Original-Received: from localhost ([::1]:55662 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mMXva-0002JQ-LP for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Sep 2021 11:49:58 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:46692) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mMXuL-0000so-VB for emacs-devel@gnu.org; Sat, 04 Sep 2021 11:48:41 -0400 Original-Received: from mail-oi1-x22e.google.com ([2607:f8b0:4864:20::22e]:38890) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mMXuK-0001OG-IN; Sat, 04 Sep 2021 11:48:41 -0400 Original-Received: by mail-oi1-x22e.google.com with SMTP id bd1so1108393oib.5; Sat, 04 Sep 2021 08:48:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=0fcoSyhjAvQlZS84dKlbmQC2WZPfcGBcyrFULRC892E=; b=pEmgDOVMl1zdBa6VufQg53OodOTo088AvV9ThzB40WQQgwIZVcLJo3aFSNsXKJCgmy dVjV2jIp6zfhh1YgMovAC+T68JV451FxbsFSYCf1jjIijStl3GlNsSrY5ODuBGQGlrw/ nS+EP6TPqUUXDq/7NJFqgrCWjqOt1Zq7LE7z/V0dwcYSZ06DgVTyx4hz+HNDrijwiWuI qiFM6N2PzNIKVdfRyGVytoLLUbkIfbG8OS0BqwZlEaS1BAmXTTs4K5HlEzMXfjp1F/Ih rThcQOFDBMnZywUxDpiWm6Z6gtA/TZaMyGJ8dUqgy/wLaeQNh1/XmgjWkQjn5wPOFG6+ p8Jw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=0fcoSyhjAvQlZS84dKlbmQC2WZPfcGBcyrFULRC892E=; b=qKQNUEtnOh6XJtUzmHyGREXjfVPySLRiSku2qCD/+YlRcHPk9o/gTwXvSnWIZxl3lE 9Lrqt1nsZ2r7hnEDrMAZ0Nes3+oCIDvyy4YOLHESeo1/VJuX68QBPGPFtnIX/rCenOGo VgmmJXevSdBGwNVUHB9xwZxjmmXr5Ty/2Ev89hmgNCxeab/zIWRV77utW0kmeXA4518y nX+EaGGuHPqE2E7R6et9vxemz8M/ElsTrElAfOun0UfB9Cfk4MTgitYC1UUlK5K/5bXi r7XqHEZ2iCcfkkeZd1Cm2wU0cKjeuhm6qZgrl8GeEIhJ3kGNfuh6pfaQBxNa6RATTzDI VYVA== X-Gm-Message-State: AOAM531rXCNrkiN+d+rKpc7PqnjGVK8NpY+R5h5XGMRat1P/OEibs8et v9jsNeX7MpndMh8DMhl0NDyMfV7r7DxQRw/F X-Google-Smtp-Source: ABdhPJyiXyPWPM30EEVK8NSCBBTXG2QQwp9w12Uta5rLX4u1TtozgxTgV4Y5pMa+MvyWAbsLYhxmpQ== X-Received: by 2002:a54:4589:: with SMTP id z9mr2997047oib.22.1630770518618; Sat, 04 Sep 2021 08:48:38 -0700 (PDT) Original-Received: from smtpclient.apple ([2600:1700:2ec7:8c9f:a86e:bc67:ca96:8c27]) by smtp.gmail.com with ESMTPSA id 21sm553310oij.39.2021.09.04.08.48.37 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Sat, 04 Sep 2021 08:48:37 -0700 (PDT) In-Reply-To: <83tuj0x09l.fsf@gnu.org> X-Mailer: Apple Mail (2.3654.120.0.1.13) Received-SPF: pass client-ip=2607:f8b0:4864:20::22e; envelope-from=casouri@gmail.com; helo=mail-oi1-x22e.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:273910 Archived-At: > On Sep 4, 2021, at 12:33 AM, Eli Zaretskii wrote: >=20 >> From: Yuan Fu >> Date: Fri, 3 Sep 2021 22:35:40 -0700 >> Cc: emacs-devel@gnu.org >>=20 >> Here is the first page/node of tree-sitter=E2=80=99s manual, do you = think the third paragraph is redundant? >=20 > No, I think it provides a useful overview of the process, and is > concise enough not to get in the way. Good job! Thank you for your kind words :-) >=20 >> And, IIUC nodes are uniquely named in a manual, I think maybe it=E2=80=99= s not a good idea to use generic node names like =E2=80=9CLanguage = Definition=E2=80=9D, =E2=80=9CPattern Matching=E2=80=9D, etc >=20 > Why not? Once again, if we ever support other similar libraries, we > should strive to have similar facilities described in the same nodes, > not in separate nodes. Not general in that sense, but in the sense that some other Emacs = feature unrelated to parsing could need that name. For example, pcase is = a kind of =E2=80=9CPattern Matching=E2=80=9D, an input method could have = a =E2=80=9CLanguage Definition=E2=80=9D. Yuan=