From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Philippe Vaucher Newsgroups: gmane.emacs.devel Subject: Re: Prefixed manual describe-function and api overview Date: Sun, 7 Jun 2020 14:10:27 +0200 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="72909"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Emacs developers To: Richard Stallman Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 07 14:11:26 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 1jhu98-000Isx-94 for ged-emacs-devel@m.gmane-mx.org; Sun, 07 Jun 2020 14:11:26 +0200 Original-Received: from localhost ([::1]:57542 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jhu97-0002LO-AM for ged-emacs-devel@m.gmane-mx.org; Sun, 07 Jun 2020 08:11:25 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:47360) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jhu8f-0001wX-HU for emacs-devel@gnu.org; Sun, 07 Jun 2020 08:10:57 -0400 Original-Received: from mail-lj1-x233.google.com ([2a00:1450:4864:20::233]:42303) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jhu8e-0006H9-LY; Sun, 07 Jun 2020 08:10:57 -0400 Original-Received: by mail-lj1-x233.google.com with SMTP id y11so15400149ljm.9; Sun, 07 Jun 2020 05:10:55 -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 :cc; bh=JXtKmFQtez/CW7nnripZ6+EwLwVnwigoWpBKAg58gsA=; b=rgV8Ul9Ua1221jjPbU4+KBWucArP07ayDnnERBiNq/MjUf4FW+zsyfOPcdWdgxsDoO RaYAwKqvgGVWze1IL5zapBDSGzp4mJgUKbRtrRkAeBcJ2AUpC63U9G+d/zRim8YEaFqk AXaxUzeYGWXipbuj9cpoQHPBb9UvFlxj42GgkWsq9aItMwutDHoBUz+hYV272m9uy4ww V6+hvb78bQFXh3SAuaVAtydcVCAfGHcRjnYVMujkuhkd/WiwIr9NHXUFPgXzZpCK6FDH HfCNMRzhuDw15th/7PVMRF9Vk+PJ2IPB1/FhNT/9igZLaIhfdi1IngQ2gES7/nierTDB GgVQ== 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:cc; bh=JXtKmFQtez/CW7nnripZ6+EwLwVnwigoWpBKAg58gsA=; b=Jn6LgJeqdTc4JxmX8og4+vZBPoaMAkckiI4x0BgkVtbSn8spwNky4/JHyqxHXRpmmr opaLiIZxnNiMV/6oVBW363HasCoJjC852av5tOWQicszECr+k4A0Cm3sIz3izzNT8SRK EMheVTkPnEYUFvpXFAIA6DwmnLFfkGqsgr730QTwUXWrOtG6tjB2qM1hP7nRk9rlrEwh Wp6dNZwkK+hdsfxK/nj0nzyetJO48hjZ0N/F9O5MMO0HsXPofGTVpFyLuKJB5sCD9wqe HqCkfnKLc/hk5T/OBIoJdhG6/jGSbnQJUVW2kRZahzTWvtJTwk68hik3LnXKvUzxg/5f hUTw== X-Gm-Message-State: AOAM533K2BAL9V56tCuuP3JkYxJfKATCo8X01Ax30c9JWj/9E5fov/1i T+Oi14N8dDJGiIbiSgfPNfB7uHdZNciBErP089yPEmc9 X-Google-Smtp-Source: ABdhPJyG0DHlh0+WKsXWbhtS+Vd+PXFUHJZHH1dXEGHGr8pIOG2jyhehXDNWtt0/6ebsF6TbIGV9NgwqDk3qjDFFSTY= X-Received: by 2002:a2e:a495:: with SMTP id h21mr9079482lji.436.1591531853517; Sun, 07 Jun 2020 05:10:53 -0700 (PDT) In-Reply-To: Received-SPF: pass client-ip=2a00:1450:4864:20::233; envelope-from=philippe.vaucher@gmail.com; helo=mail-lj1-x233.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_PASS=-0.001, URIBL_BLOCKED=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:252005 Archived-At: > > 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