all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* Writing manuals
@ 2021-08-17  6:42 Yuan Fu
  2021-08-17 11:37 ` Eli Zaretskii
  0 siblings, 1 reply; 21+ messages in thread
From: Yuan Fu @ 2021-08-17  6:42 UTC (permalink / raw)
  To: emacs-devel

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


^ permalink raw reply	[flat|nested] 21+ messages in thread

end of thread, other threads:[~2021-09-05 20:02 UTC | newest]

Thread overview: 21+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
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

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.