all messages for Emacs-related lists mirrored at yhetil.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: Wed, 18 Aug 2021 05:26:51 +0300	[thread overview]
Message-ID: <83eear5vys.fsf@gnu.org> (raw)
In-Reply-To: <DB12FE60-2540-4D7B-BB02-C7ABFD96A9BD@gmail.com> (message from Yuan Fu on Tue, 17 Aug 2021 13:08:52 -0700)

> From: Yuan Fu <casouri@gmail.com>
> 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.



  reply	other threads:[~2021-08-18  2:26 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 [this message]
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
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

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

  git send-email \
    --in-reply-to=83eear5vys.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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.