From: Yuan Fu <casouri@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: emacs-devel <emacs-devel@gnu.org>
Subject: Re: Writing manuals
Date: Tue, 17 Aug 2021 09:28:53 -0700 [thread overview]
Message-ID: <502702DF-70A7-4FCC-93FD-08E984673832@gmail.com> (raw)
In-Reply-To: <83czqc715e.fsf@gnu.org>
> On Aug 17, 2021, at 4:37 AM, Eli Zaretskii <eliz@gnu.org> wrote:
>
>> From: Yuan Fu <casouri@gmail.com>
>> Date: Mon, 16 Aug 2021 23:42:11 -0700
>>
>> I want to start writing manuals for tree-sitter api (since I don’t expect much change in that part) and I have some questions:
>>
>> 1. It seems that I need to write description for each function again, apart from the doc string that I already wrote. Any tips to make it easier? (I imagine in many cases I can just copy the doc string’s content?)
>
> If you are going to just copy the doc strings, the value of the manual
> will not be high, perhaps not even high enough to justify a manual. A
> good manual doesn't repeat doc strings, it (a) describes the APIs in
> more detail, preferably with useful examples; and (b) includes textual
> "glue" between the API descriptions that facilitates reading the
> manual by a person who needs to study the API for the first time (as
> opposed to use it as a reference).
>
> IOW, a good manual should have a meaningful introduction and overview
> chapters, and should describe the APIs in some logical order, with
> "continuity" text that tells a story, not just lists the functions and
> variables one by one.
Ah, got it. I know how to write it now.
>
>> 2. How do I refer to some manual node in the doc string?
>
> This is described in the node "Documentation Tips" of the ELisp
> manual.
Thanks.
>
>> 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.
>
>> 4. Any general tips I should know before starting? doc/lispref/README doesn’t say anything helpful.
>
> General tips about using Texinfo are in the Texinfo manual, they are
> not specific to Emacs. If you have more specific questions, please
> ask them.
Ok.
Yuan
next prev parent reply other threads:[~2021-08-17 16:28 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 [this message]
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
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=502702DF-70A7-4FCC-93FD-08E984673832@gmail.com \
--to=casouri@gmail.com \
--cc=eliz@gnu.org \
--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).