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: Tue, 17 Aug 2021 20:20:44 +0300 Message-ID: <83tujo56oj.fsf@gnu.org> References: <60B2E271-2E91-4906-940E-425A76ED0DCD@gmail.com> <83czqc715e.fsf@gnu.org> <502702DF-70A7-4FCC-93FD-08E984673832@gmail.com> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8245"; 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 Tue Aug 17 19:21:34 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 1mG2mM-0001md-DA for ged-emacs-devel@m.gmane-mx.org; Tue, 17 Aug 2021 19:21:34 +0200 Original-Received: from localhost ([::1]:43286 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mG2mL-0002Pa-9z for ged-emacs-devel@m.gmane-mx.org; Tue, 17 Aug 2021 13:21:33 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42786) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mG2la-0001gh-S4 for emacs-devel@gnu.org; Tue, 17 Aug 2021 13:20:46 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:38708) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mG2la-0002bq-HM; Tue, 17 Aug 2021 13:20:46 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:3456 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 1mG2la-0002vO-3s; Tue, 17 Aug 2021 13:20:46 -0400 In-Reply-To: <502702DF-70A7-4FCC-93FD-08E984673832@gmail.com> (message from Yuan Fu on Tue, 17 Aug 2021 09:28:53 -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:272505 Archived-At: > From: Yuan Fu > Date: Tue, 17 Aug 2021 09:28:53 -0700 > Cc: emacs-devel > > >> 3. Where should I put the tree-sitter node in the manual? > > > > You mean, in the ELisp manual? I think each group of APIs should be > > described where it belongs: the fontification-related APIs where > > font-lock is described, indentation-related APIs where indentation > > facilities are documented, etc. > > I was referring to tree-sitter API, i.e., wrappers of tree-sitter functions. They are the functions that I expect to not change much. Font-lock and indent API are still undecided for the most part. So where should I put the manual of tree-sitter functions? In that node I will talk about what can tree-sitter do and how to use the parser and parse-tree, etc. I'm not sure I see the difference. We have syntax-ppss etc. documented in the ELisp manual; how are TS-related APIs different?