From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: =?UTF-8?B?Sm/Do28gVMOhdm9yYQ==?= Newsgroups: gmane.emacs.devel Subject: Re: Prefixed manual describe-function and api overview Date: Thu, 11 Jun 2020 20:13:57 +0100 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="83307"; mail-complaints-to="usenet@ciao.gmane.io" To: Philippe Vaucher , emacs-devel Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Jun 11 21:15:07 2020 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 1jjSfL-000LaX-BO for ged-emacs-devel@m.gmane-mx.org; Thu, 11 Jun 2020 21:15:07 +0200 Original-Received: from localhost ([::1]:33434 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jjSfK-00020U-Bh for ged-emacs-devel@m.gmane-mx.org; Thu, 11 Jun 2020 15:15:06 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35406) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jjSeX-0001KG-Qy for emacs-devel@gnu.org; Thu, 11 Jun 2020 15:14:17 -0400 Original-Received: from mail-il1-x12d.google.com ([2607:f8b0:4864:20::12d]:44601) by eggs.gnu.org with esmtps (TLS1.3:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jjSeW-0001u7-5p for emacs-devel@gnu.org; Thu, 11 Jun 2020 15:14:17 -0400 Original-Received: by mail-il1-x12d.google.com with SMTP id i1so6499559ils.11 for ; Thu, 11 Jun 2020 12:14:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :content-transfer-encoding; bh=jsoJ3o5P6FWorneT2rsxMIyr7XsgSmR+doO14TW9EJ4=; b=XlUztJNeeK086fc6jbQUl21n75xdJMXJ/p6npf5ae1KQFoW/xNLe54byd73m325DR4 btigAO7tAdbjPlB0V9fYcsHfffXcR2pikrgOhVvs9F9KTjQ88RP5OEBoynp2hYOveCRZ F41snWKOuq5xFmehbJdGjUZqZ5DR2fvRp9uHEV+F/Z20zIA31MES5rVG4cLiYk18ckAX dvtoGlfSoCmWuBQxZok9ZZuzJZJFsgBRNYGCAN3cbJ/mQFci3K13D9aYUuTz2nPwQjjz vPJdLRKjSh5KiGCTjJlHdfpnpYWD8ejI1kvAcQHtpaeti7jTxfzshqfq7PdSjKXOXPLl Js7g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:content-transfer-encoding; bh=jsoJ3o5P6FWorneT2rsxMIyr7XsgSmR+doO14TW9EJ4=; b=ATl8Y23zvGT9vi1NFjEaVBh9OwXc/RQie6PkUUnEfWOw38njynEeZzU7TGwdLT08sB HrsmTwDgnh+iqImgHcASafGTm9MtW6eMTnQqtdpLJHwmhtC706VWis8SD9Y53Kb4IFnr CZ08HbKwiXyS1HwiN04nbbq23JlLt8FrPbVUCFmBsHLGfdw18AAfkspRuRmr9iJe4OVU k+spu15wzy4PgTbx3iuCb53i7gMmEWLLES3k8zbrAkU2BnkzOG52RhMtdvHYeeGYRGPd h6IUcQbRkuUGJBCifXZ6IbIwLr1Y5R7nshLuSc2wyj9E2pp6UZMMvTH2z2ajutbLxxG4 qwCQ== X-Gm-Message-State: AOAM533DghLYRIYXeEcfuoIBw7Wx2AEwREybjaOzye2/kscqDLogTs0T qSYP0xDrvW3Ron9Pot2QCGWA+9zOw9acesWpcgU= X-Google-Smtp-Source: ABdhPJyrgNhN4aiM+iY84cB9Of3rWSBvn/r5aR9GuVVJlFBX7M0bTO9CQQHhN24/IuiPjMTcJgPd9UgKK078rfg8/gc= X-Received: by 2002:a92:de41:: with SMTP id e1mr9380030ilr.199.1591902848767; Thu, 11 Jun 2020 12:14:08 -0700 (PDT) In-Reply-To: Received-SPF: pass client-ip=2607:f8b0:4864:20::12d; envelope-from=joaotavora@gmail.com; helo=mail-il1-x12d.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. 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=_AUTOLEARN 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:252128 Archived-At: Hello Philippe, [I take the liberty from answering to emacs-devel, since you seem to be requesting that I weigh in on your work, which is public] > I'm surprised not to hear from you on this. Maybe you missed it? > > IIRC you were the one pushing for me to implement it, maybe I misremember= . You don't. I have variable amounts of energy to invest in Emacs development, and I didn't think my input would be crucial here. Sorry about that, and thank you for your work. I read your email, but was discouraged from trying your program since you made it depend on s.el and dash.el which are libraries I don't use and steer clear of. Certainly with 120 lines of code you can write it without s.el and dash.el, especially now that you've supposedly become accustomed with Emacs's API's. But I read the code. You approach is completely different from what I imagined: I was thinking of creating new sections in the manual itself, or creating a whole new manual, without having to actually write the contents for it. It could be called the "Elisp API manual", or some better name. One could visit that API manual from inside and from outside Emacs, just as one does now with the normal Manual. A minimal amount of Elisp code would allow some C-h function to take me there. In other words, as you know, a manual in Emacs is extracted from the Texinfo source (.texi files) into various output formats. I was thinking about code that performs this extraction into a new output (a new manual, or a new section in the existing Elisp manual) including all those formats. Without needing to touch the (.texi) files themselves. Maybe this could be done with a special Texinfo macro, maybe redefining its built-in @defun macro, which is what Emacs uses to introduce a function definition. That was my idea. Hope this helps, Jo=C3=A3o T=C3=A1vora