From: Yuan Fu <casouri@gmail.com>
To: emacs-devel <emacs-devel@gnu.org>
Subject: Writing manuals
Date: Mon, 16 Aug 2021 23:42:11 -0700 [thread overview]
Message-ID: <60B2E271-2E91-4906-940E-425A76ED0DCD@gmail.com> (raw)
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?)
2. How do I refer to some manual node in the doc string?
3. Where should I put the tree-sitter node in the manual?
4. Any general tips I should know before starting? doc/lispref/README doesn’t say anything helpful.
Yuan
next reply other threads:[~2021-08-17 6:42 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-17 6:42 Yuan Fu [this message]
2021-08-17 11:37 ` Writing manuals 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
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=60B2E271-2E91-4906-940E-425A76ED0DCD@gmail.com \
--to=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.