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: Wed, 18 Aug 2021 05:26:51 +0300 Message-ID: <83eear5vys.fsf@gnu.org> References: <60B2E271-2E91-4906-940E-425A76ED0DCD@gmail.com> <83czqc715e.fsf@gnu.org> <502702DF-70A7-4FCC-93FD-08E984673832@gmail.com> <83tujo56oj.fsf@gnu.org> <83o89v6hsd.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="10936"; 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 Wed Aug 18 04:27:26 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 1mGBIb-0002d0-Fn for ged-emacs-devel@m.gmane-mx.org; Wed, 18 Aug 2021 04:27:25 +0200 Original-Received: from localhost ([::1]:41636 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mGBIa-0000ua-29 for ged-emacs-devel@m.gmane-mx.org; Tue, 17 Aug 2021 22:27:24 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34034) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mGBI5-0000Ek-1C for emacs-devel@gnu.org; Tue, 17 Aug 2021 22:26:53 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:59006) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mGBI4-0000dm-Qa; Tue, 17 Aug 2021 22:26:52 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:4910 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 1mGBI4-0005c2-Ag; Tue, 17 Aug 2021 22:26:52 -0400 In-Reply-To: (message from Yuan Fu on Tue, 17 Aug 2021 13:08:52 -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:272537 Archived-At: > From: Yuan Fu > Date: Tue, 17 Aug 2021 13:08:52 -0700 > Cc: emacs-devel@gnu.org > > > No, "Text" is for other stuff. I think a separate chapter, something > > like "Parsing Program Source". As long as you are talking about > > general-purpose parsing functions, not their use for font-lock etc. > > Ok, I would name it “Parsing Program Source with Tree-sitter”, because it isn’t a generic parsing facility, but really a tree-sitter integration. No, please don't use TS-specific chapter names. In the text, you can tell that the functions you describe require the tree-sitter library, but the chapter and section names should ideally be neutral, so we could later add stuff provided by other libraries, like LSP. > Another question, do I need to @vindex a variable every time I mention it, or I only need to @vindex it once, at where I explain the variable? The latter. The other places, if they are in another node, should have a cross-reference to that single description.