unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "João Távora" <joaotavora@gmail.com>
To: Philippe Vaucher <philippe.vaucher@gmail.com>,
	emacs-devel <emacs-devel@gnu.org>
Subject: Re: Prefixed manual describe-function and api overview
Date: Thu, 11 Jun 2020 20:13:57 +0100	[thread overview]
Message-ID: <CALDnm50bVrhReKc+xh8t8ULzPXSX4YRUfmgKVL_JLk_hes0Q2Q@mail.gmail.com> (raw)
In-Reply-To: <CAGK7Mr4_2zus2Hq9=ArpR-ya6FNxxqXWvDxLGTsHsH4-XuM=CQ@mail.gmail.com>

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 <key> 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ão Távora



  parent reply	other threads:[~2020-06-11 19:13 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-04  9:39 Prefixed manual describe-function and api overview Philippe Vaucher
2020-06-04 12:16 ` Stefan Monnier
2020-06-04 14:06   ` Philippe Vaucher
     [not found] ` <E1jh2ly-000090-Hp@fencepost.gnu.org>
2020-06-05  7:55   ` Philippe Vaucher
2020-06-06  3:59     ` Richard Stallman
2020-06-07 12:10       ` Philippe Vaucher
2020-06-08  3:35         ` Richard Stallman
     [not found] ` <CAGK7Mr4_2zus2Hq9=ArpR-ya6FNxxqXWvDxLGTsHsH4-XuM=CQ@mail.gmail.com>
2020-06-11 19:13   ` João Távora [this message]
2020-06-12 14:18     ` Philippe Vaucher
2020-06-12 16:02       ` João Távora
2020-06-13  9:23         ` Philippe Vaucher
2020-06-13 13:41           ` João Távora
2020-06-13 15:46             ` Philippe Vaucher
2020-06-13 16:41               ` Dmitry Gutov

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=CALDnm50bVrhReKc+xh8t8ULzPXSX4YRUfmgKVL_JLk_hes0Q2Q@mail.gmail.com \
    --to=joaotavora@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=philippe.vaucher@gmail.com \
    /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).