emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Writing manuals


From: Yuan Fu
Subject: Re: Writing manuals
Date: Sat, 4 Sep 2021 08:48:36 -0700


> On Sep 4, 2021, at 12:33 AM, Eli Zaretskii <eliz@gnu.org> wrote:
> 
>> From: Yuan Fu <casouri@gmail.com>
>> 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!

Thank you for your kind words :-)

> 
>> 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.

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 
“Pattern Matching”, an input method could have a “Language Definition”.

Yuan


reply via email to

[Prev in Thread] Current Thread [Next in Thread]