From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Yuan Fu Newsgroups: gmane.emacs.devel Subject: Writing manuals Date: Mon, 16 Aug 2021 23:42:11 -0700 Message-ID: <60B2E271-2E91-4906-940E-425A76ED0DCD@gmail.com> Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.60.0.2.21\)) Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="22110"; mail-complaints-to="usenet@ciao.gmane.io" To: emacs-devel Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Aug 17 08:43:11 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mFsoX-0005aw-K9 for ged-emacs-devel@m.gmane-mx.org; Tue, 17 Aug 2021 08:43:09 +0200 Original-Received: from localhost ([::1]:38960 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mFsoW-0000ZP-Bl for ged-emacs-devel@m.gmane-mx.org; Tue, 17 Aug 2021 02:43:08 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54526) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mFsng-0008GF-AR for emacs-devel@gnu.org; Tue, 17 Aug 2021 02:42:16 -0400 Original-Received: from mail-pj1-x1031.google.com ([2607:f8b0:4864:20::1031]:51812) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mFsne-0005sj-Mm for emacs-devel@gnu.org; Tue, 17 Aug 2021 02:42:16 -0400 Original-Received: by mail-pj1-x1031.google.com with SMTP id oa17so30557259pjb.1 for ; Mon, 16 Aug 2021 23:42:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:content-transfer-encoding:mime-version:subject:message-id:date :to; bh=g6KrDThDnrUM0U35pUQ64ReSkwPFAixbbjXbcI1rrXA=; b=PDraK+Aj8t/cptbAgaW/AM5FNBFWXA+CbJFwcvBTIWmJF3uK8RL/j/x+1UyStPgABa 5/sP2ZTLmpEqnQPHbH1l6KxGOfOMvv7z0kwLEZ02R8UfLC8nnKJzVb4hVwiaLVCrnLgu tH2CFeb2BiXZyLBL0TWgvcjBTBFzgTntZZVl9XOIMQgHf28kL38x0vevJ0DZqIOWhff8 FKKWR/bIm//9TNV5z1IxE+w+XJO+a+R5QOQ7NnCPkbLCWzFLpS1Zp4TK3/7muRUuEYMk GL4e3fPXPEx77XVy650cj7GTYsd9OLZO+fa+plJqy7lW17JlOPn4wQT/GFkVrglWWiGQ 0tbA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:content-transfer-encoding:mime-version :subject:message-id:date:to; bh=g6KrDThDnrUM0U35pUQ64ReSkwPFAixbbjXbcI1rrXA=; b=lRQsYku43WZnxQBtJSLMLoRL4F0I+II+V9F9JKrYqvuAFY4Xs4+dnzxRHvA0VTfUYO 7x8rWIUhmBe83nxfY/Pj/hZ8jPaV54D4vp+5XR58vDvUXuhzkIN9M79wUloUEdSoTjH8 RgGUhbKSJwH5pEhXJCWr/9GkZ+evI3YaYEJD8mkkaN621b8joFlG2XulW4o2Zk23sabT Kj54qOixBZtpwDblREAYrtZujetTVpjWjG0sNkOf/ErJaL1S9OU/nC839zGW+wkLJhug jpKhTJshuGZMDy6qa9apHZggn9cCvj4jcHSX7yXI+y9BBNuaeQi1niP76Uianlw4QCzG 5zdg== X-Gm-Message-State: AOAM533PoOvplD0H65gE6ck8YS0DqMOGQho3h4isdfcWLqfBNgyfwP2x UHz9YZnV88RBUspQkRhAvqwIb3oiC0g= X-Google-Smtp-Source: ABdhPJzS/U8WwH9kCgK0J5lHcSpw1EQLJs+mVyPdf3EDcR5jMUjGgpo/+l3vxEvMaf+r/F4IIPgBDg== X-Received: by 2002:a17:90a:bb0b:: with SMTP id u11mr2102539pjr.18.1629182533119; Mon, 16 Aug 2021 23:42:13 -0700 (PDT) Original-Received: from 2603-8000-d900-871b-fc74-54d8-c576-7900.res6.spectrum.com (2603-8000-d900-871b-fc74-54d8-c576-7900.res6.spectrum.com. [2603:8000:d900:871b:fc74:54d8:c576:7900]) by smtp.gmail.com with ESMTPSA id g3sm1232248pfi.197.2021.08.16.23.42.12 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Mon, 16 Aug 2021 23:42:12 -0700 (PDT) X-Mailer: Apple Mail (2.3654.60.0.2.21) Received-SPF: pass client-ip=2607:f8b0:4864:20::1031; envelope-from=casouri@gmail.com; helo=mail-pj1-x1031.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:272476 Archived-At: I want to start writing manuals for tree-sitter api (since I don=E2=80=99t= 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=E2=80=99s = 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=E2=80=99t say anything helpful. Yuan=