From: Philippe Vaucher <philippe.vaucher@gmail.com>
To: Richard Stallman <rms@gnu.org>, Emacs developers <emacs-devel@gnu.org>
Subject: Re: Prefixed manual describe-function and api overview
Date: Fri, 5 Jun 2020 09:55:08 +0200 [thread overview]
Message-ID: <CAGK7Mr5VHAv8=Dvt1aT0YghHR+K6v6hUMk+n8=atEhSj0nspTA@mail.gmail.com> (raw)
In-Reply-To: <E1jh2ly-000090-Hp@fencepost.gnu.org>
> > Following up on our previous discussions, here is a working
> > implementation of the completion mechanism based on the manual:
>
> Could you tell me in 6 lines what it does?
Right sorry, I should have said it anyway. I added the mailing list
for others to have my description as well.
There are several function, but the one I mainly want to show you guys
is `prefixed-manual-describe-function`. It is like `describe-function`
(C-h f), but before you get to select a function you have to select a
"topic" first. The topics are the clickable links at
https://www.gnu.org/software/emacs/manual/html_node/elisp/index.html#Top.
Once you select a topic, then you get to select a function but your
choices are limited to the functions of said topic.
This simulates the experience you get when you have a consistently prefixed api.
If you want to get a quick overview, please eval the following code
and select "Strings and Characters" for the topic (the example is
hardcoded to propose string functions):
(let ((topic (completing-read "Topic: " '("Introduction" "Lisp Data
Types" "Numbers" "Strings and Characters" "Lists" "Sequences Arrays
Vectors" "Records" "Hash Tables" "Symbols" "Evaluation" "Control
Structures")))
(function (intern (completing-read "Function: " '("stringp"
"string-or-null-p" "char-or-string-p" "make-string" "string"
"substring" "substring-no-properties" "concat" "split-string"
"store-substring" "clear-string" "char-equal" "string" "string-equal"
"string-collate-equalp" "string" "string-lessp" "string-greaterp"
"string-collate-lessp" "string-version-lessp" "string-prefix-p"
"string-suffix-p" "compare-strings" "assoc-string" "number-to-string"
"string-to-number" "char-to-string" "string-to-char" "format"
"format-message" "downcase" "upcase" "capitalize" "upcase-initials"
"case-table-p" "set-standard-case-table" "standard-case-table"
"current-case-table" "set-case-table" "set-case-syntax-pair"
"set-case-syntax-delims" "set-case-syntax"
"describe-buffer-case-table")))))
(describe-function function))
Kind regards,
Philippe
next prev parent reply other threads:[~2020-06-05 7:55 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 [this message]
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='CAGK7Mr5VHAv8=Dvt1aT0YghHR+K6v6hUMk+n8=atEhSj0nspTA@mail.gmail.com' \
--to=philippe.vaucher@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=rms@gnu.org \
/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).