unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Philippe Vaucher <philippe.vaucher@gmail.com>
To: "Emacs developers" <emacs-devel@gnu.org>,
	"João Távora" <joaotavora@gmail.com>,
	"Eli Zaretskii" <eliz@gnu.org>
Subject: Prefixed manual describe-function and api overview
Date: Thu, 4 Jun 2020 11:39:22 +0200	[thread overview]
Message-ID: <CAGK7Mr4TfzcrrK0GZZVgujvcrh4vqeHkS4Eo+_1cB6r7=eMzSw@mail.gmail.com> (raw)

Hello,

Following up on our previous discussions, here is a working
implementation of the completion mechanism based on the manual:

https://github.com/Silex/prefixed-manual.el/blob/master/prefixed-manual.el

At the moment it uses https://melpa.org/#/dash and
https://melpa.org/#/s so make sure you have these dependencies. Then
to try it out, test with `M-x prefixed-manual-describe-function` and
`M-x prefixed-manual-overview`. The later still needs a lot of work
but it gives an idea.

Here are my questions/plans:
- If there is interest for some parts for the core, I'll rewrite this
in vanilla Emacs.
- I'm not sure I like "prefixed-manual", given this is more about
"manual-helpers". Feel free to suggest a better name.
- In `prefixed-manual-overview`, I'd like to display the full
signature of functions. For example display "(substring-no-properties
STRING &optional FROM TO)" instead of "substring-no-properties". If
you know a simple way I'm interested. I tried to use something like
`(get 'substring-no-properties 'function-documentation)` or play with
`documentation-property` but couldn't find easily and gave up.

Kind regards,
Philippe



             reply	other threads:[~2020-06-04  9:39 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-04  9:39 Philippe Vaucher [this message]
2020-06-04 12:16 ` Prefixed manual describe-function and api overview 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
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='CAGK7Mr4TfzcrrK0GZZVgujvcrh4vqeHkS4Eo+_1cB6r7=eMzSw@mail.gmail.com' \
    --to=philippe.vaucher@gmail.com \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=joaotavora@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).