[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Writing manuals
From: |
Eli Zaretskii |
Subject: |
Re: Writing manuals |
Date: |
Wed, 18 Aug 2021 05:26:51 +0300 |
> 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.
- Writing manuals, Yuan Fu, 2021/08/17
- Re: Writing manuals, Eli Zaretskii, 2021/08/17
- Re: Writing manuals, Yuan Fu, 2021/08/17
- Re: Writing manuals, Eli Zaretskii, 2021/08/17
- Re: Writing manuals, Yuan Fu, 2021/08/17
- Re: Writing manuals, Eli Zaretskii, 2021/08/17
- Re: Writing manuals, Yuan Fu, 2021/08/17
- Re: Writing manuals,
Eli Zaretskii <=
- Re: Writing manuals, Yuan Fu, 2021/08/17
- Re: Writing manuals, Eli Zaretskii, 2021/08/18
- Re: Writing manuals, Richard Stallman, 2021/08/18
- Re: Writing manuals, Eli Zaretskii, 2021/08/19
- Re: Writing manuals, Yuan Fu, 2021/08/19
- Re: Writing manuals, Eli Zaretskii, 2021/08/19
- Re: Writing manuals, Fu Yuan, 2021/08/19
- Re: Writing manuals, Eli Zaretskii, 2021/08/19