From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED] Date: Fri, 16 Oct 2020 09:39:33 +0300 Message-ID: <83imbawu6y.fsf@gnu.org> References: <20201015190929.gdvx7j2yukcdcoaw@E15-2016.optimum.net> <83pn5jwav0.fsf@gnu.org> <20201015194132.jdn3e2v62vfvh7ju@E15-2016.optimum.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="34645"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Boruch Baum Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Oct 16 08:40:40 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 1kTJPr-0008vD-9w for ged-emacs-devel@m.gmane-mx.org; Fri, 16 Oct 2020 08:40:39 +0200 Original-Received: from localhost ([::1]:42356 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kTJPq-0000o3-B5 for ged-emacs-devel@m.gmane-mx.org; Fri, 16 Oct 2020 02:40:38 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54168) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kTJOv-0000KH-71 for emacs-devel@gnu.org; Fri, 16 Oct 2020 02:39:41 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:41499) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kTJOu-0003dW-Iz; Fri, 16 Oct 2020 02:39:40 -0400 Original-Received: from [176.228.60.248] (port=4448 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1kTJOr-00009s-5c; Fri, 16 Oct 2020 02:39:40 -0400 In-Reply-To: <20201015194132.jdn3e2v62vfvh7ju@E15-2016.optimum.net> (message from Boruch Baum on Thu, 15 Oct 2020 15:41:32 -0400) 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:257777 Archived-At: > Date: Thu, 15 Oct 2020 15:41:32 -0400 > From: Boruch Baum > Cc: emacs-devel@gnu.org > > I just now double-checked, and my "C-h P" binds to a function > `describe-package'. Is that what you mean? That function produces very > different content in a very different format. What I submitted is > proof-of-concept code, which *could* be integrated into > `describe-package'; I'm not picky. Here are some of the differences: > > > + describe-package doesn't operate on all emacs-lisp files > + try performing it on `dired' or dired.el > > + describe-package does in fact extract the *first* section of header > documentation commentary. > + What it omits, that is in the proposal is all the rest of the header > documentation, which in many cases includes information on > installation, configuration, usage, examples, known bugs, etc. > > + describe package provides information on package 'status' (eg. > built-in, external) which isn't in my POC. > > + My POC function additionally formats and presents *all* the > documentation for all the package's symbols. > + and it's done in an org-mode hierarchy for your navigating pleasure. Thanks. To me this sounds like your code could be used to extend "C-h P" in useful ways. Perhaps the result of "C-h P" should include a button "More information" or something that could produce an Org buffer with the additional stuff. WDYT? The main point, I think, is not to create another command whose functionality overlaps with an existing one, but instead extend the existing command to do more when requested.