From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.devel Subject: Re: master 2a7488d: Add support for displaying short documentation for function groups Date: Tue, 13 Oct 2020 23:05:40 +0300 Organization: LINKOV.NET Message-ID: <87eem2ey3n.fsf@mail.linkov.net> References: <20201011035127.7723.3256@vcs0.savannah.gnu.org> <20201011035128.E3FD320667@vcs0.savannah.gnu.org> <87k0vxquvo.fsf@gnus.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1485"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (x86_64-pc-linux-gnu) Cc: emacs-devel@gnu.org To: Lars Ingebrigtsen Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Oct 13 22:23:09 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 1kSQpA-0000Fw-Lc for ged-emacs-devel@m.gmane-mx.org; Tue, 13 Oct 2020 22:23:08 +0200 Original-Received: from localhost ([::1]:39060 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kSQp9-0002Cj-KP for ged-emacs-devel@m.gmane-mx.org; Tue, 13 Oct 2020 16:23:07 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51792) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kSQlk-0007f9-9r for emacs-devel@gnu.org; Tue, 13 Oct 2020 16:19:36 -0400 Original-Received: from relay4-d.mail.gandi.net ([217.70.183.196]:34071) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kSQli-0006uT-Cw for emacs-devel@gnu.org; Tue, 13 Oct 2020 16:19:36 -0400 X-Originating-IP: 91.129.102.160 Original-Received: from mail.gandi.net (m91-129-102-160.cust.tele2.ee [91.129.102.160]) (Authenticated sender: juri@linkov.net) by relay4-d.mail.gandi.net (Postfix) with ESMTPSA id 07B56E0004; Tue, 13 Oct 2020 20:19:30 +0000 (UTC) In-Reply-To: <87k0vxquvo.fsf@gnus.org> (Lars Ingebrigtsen's message of "Sun, 11 Oct 2020 05:55:23 +0200") Received-SPF: pass client-ip=217.70.183.196; envelope-from=juri@linkov.net; helo=relay4-d.mail.gandi.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/13 16:19:32 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no 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:257578 Archived-At: >> Add support for displaying short documentation for function groups > > After tinkering with this for a while on a branch, I've now merged the > shortdoc stuff into the trunk. The main idea is taken from what is, > according to the entire internet, the Platonic ideal in documentation: > > https://github.com/magnars/s.el > > So it's a list of functions and examples. > > It could probably do with a bit more tinkering, looks-wise. > > The easiest way to experience it is to say `C-h f string-trim RET' and > then clicking on the button. I have pondered a year ago about doing something like this, but based on Info and/or HTML, i.e. to generate Info nodes with functions listed by groups in separate nodes (possibly using HTML format), so e.g. going to (info "(shortdoc) Buffer") could display an Info node with a menu of related functions, where nodes could be navigated using Info keys. Does this make sense?