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.devel Subject: Re: Writing manuals Date: Sat, 04 Sep 2021 10:33:58 +0300 Message-ID: <83tuj0x09l.fsf@gnu.org> References: <83lf4x1kme.fsf@gnu.org> <83k0kh1j84.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="23039"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Yuan Fu Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Sep 04 09:34:54 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 1mMQCT-0005iR-Ct for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Sep 2021 09:34:53 +0200 Original-Received: from localhost ([::1]:49378 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mMQCS-00057o-0s for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Sep 2021 03:34:52 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36342) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mMQBf-00040Z-Ez for emacs-devel@gnu.org; Sat, 04 Sep 2021 03:34:03 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:53332) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mMQBf-0008Pt-7K; Sat, 04 Sep 2021 03:34:03 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:4120 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 1mMQBa-00035E-5z; Sat, 04 Sep 2021 03:33:59 -0400 In-Reply-To: (message from Yuan Fu on Fri, 3 Sep 2021 22:35:40 -0700) 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:273845 Archived-At: > From: Yuan Fu > Date: Fri, 3 Sep 2021 22:35:40 -0700 > Cc: emacs-devel@gnu.org > > Here is the first page/node of tree-sitter’s manual, do you think the third paragraph is redundant? No, I think it provides a useful overview of the process, and is concise enough not to get in the way. Good job! > And, IIUC nodes are uniquely named in a manual, I think maybe it’s not a good idea to use generic node names like “Language Definition”, “Pattern Matching”, etc 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.