unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Philippe Vaucher <philippe.vaucher@gmail.com>
To: Richard Stallman <rms@gnu.org>
Cc: Emacs developers <emacs-devel@gnu.org>
Subject: Re: Prefixed manual describe-function and api overview
Date: Sun, 7 Jun 2020 14:10:27 +0200	[thread overview]
Message-ID: <CAGK7Mr6Bs6=UPvPd2PLMH1G5AV_iyQEfy=ozs0vWChL16x5Fkw@mail.gmail.com> (raw)
In-Reply-To: <E1jhPz7-0008OA-FQ@fencepost.gnu.org>

>   > 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.
>
> It is worth a try.  Let's see whether users find that helps them
> find the information they are looking for.
>
> To find out whether users find it helpful, we might want to publish it
> and ask users to try it.

Well it is published, and I asked people to try it out? Or did you mean ELPA?

> Here's an idea: make describe-function accept topic names as well as function
> names.  When the input is a topic name, it would follow up by doing what
> you've implemented.  If the minibuffer prompt explains this feature,
> users might discover it on their own.  And it won't require a new command.

I see your point but that'd defeat the purpose of the package for me.
I'd type "string" and have to figure out which one is a function and
which one is a topic.

I want less ambiguity, what you suggest adds more.

Philippe



  reply	other threads:[~2020-06-07 12:10 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 [this message]
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='CAGK7Mr6Bs6=UPvPd2PLMH1G5AV_iyQEfy=ozs0vWChL16x5Fkw@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).