unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Yuan Fu <casouri@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: Writing manuals
Date: Sat, 04 Sep 2021 10:33:58 +0300	[thread overview]
Message-ID: <83tuj0x09l.fsf@gnu.org> (raw)
In-Reply-To: <DAFD6A80-BE15-4B32-B729-572AB33447AE@gmail.com> (message from Yuan Fu on Fri, 3 Sep 2021 22:35:40 -0700)

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

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



  reply	other threads:[~2021-09-04  7:33 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-17  6:42 Writing manuals Yuan Fu
2021-08-17 11:37 ` Eli Zaretskii
2021-08-17 16:28   ` Yuan Fu
2021-08-17 17:20     ` Eli Zaretskii
2021-08-17 18:10       ` Yuan Fu
2021-08-17 18:35         ` Eli Zaretskii
2021-08-17 20:08           ` Yuan Fu
2021-08-18  2:26             ` Eli Zaretskii
2021-08-18  3:24               ` Yuan Fu
2021-08-18 12:31                 ` Eli Zaretskii
2021-08-19  2:35                   ` Richard Stallman
2021-08-19  6:53                     ` Eli Zaretskii
2021-08-19 15:59                   ` Yuan Fu
2021-08-19 16:10                     ` Eli Zaretskii
2021-08-19 16:29                       ` Fu Yuan
2021-08-19 16:40                         ` Eli Zaretskii
2021-09-04  5:35                           ` Yuan Fu
2021-09-04  7:33                             ` Eli Zaretskii [this message]
2021-09-04 15:48                               ` Yuan Fu
2021-09-04 15:54                                 ` Eli Zaretskii
     [not found]                             ` <CAJnXXoiTw_soZiBi48mJ-kKH-wWktq0EU+kJy4-bbsYZgeB=7A@mail.gmail.com>
2021-09-05 20:02                               ` Yuan Fu

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83tuj0x09l.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=casouri@gmail.com \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).