From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Boruch Baum Newsgroups: gmane.emacs.devel Subject: Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED] Date: Thu, 15 Oct 2020 15:41:32 -0400 Message-ID: <20201015194132.jdn3e2v62vfvh7ju@E15-2016.optimum.net> References: <20201015190929.gdvx7j2yukcdcoaw@E15-2016.optimum.net> <83pn5jwav0.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="17253"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: NeoMutt/20180716 Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Oct 15 21:45:23 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 1kT9Bj-0004Pw-T6 for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Oct 2020 21:45:23 +0200 Original-Received: from localhost ([::1]:44148 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kT9Bi-0001jI-OZ for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Oct 2020 15:45:22 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:55920) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kT989-0008PK-5k for emacs-devel@gnu.org; Thu, 15 Oct 2020 15:41:41 -0400 Original-Received: from mout.gmx.net ([212.227.17.21]:41159) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kT986-0006Ox-VP; Thu, 15 Oct 2020 15:41:40 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1602790895; bh=T0uktWMiyhhuZI4UQhtdNa4J5v5zLbijUYVqosg56vs=; h=X-UI-Sender-Class:Date:From:To:Cc:Subject:References:In-Reply-To; b=ez1CfVC5flylgYbBTplrp71rrgmTJpqYw2qeVv5BvpZ8zdpviTrsMw7z0dmRaSbLX 8w2N4ULxZ0/MnBu7m1XD2YuJoqvpGpLwNwN7frnMhLc+HfHmlYo9HmPywtPIfnT3xi vjr20lI2gn8b3UzDKp8vvXIEqP3+bTawdKkBQGjk= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from E15-2016.optimum.net ([72.89.170.172]) by mail.gmx.com (mrgmx104 [212.227.17.174]) with ESMTPSA (Nemesis) id 1MNKhm-1knaj70Efq-00OlLY; Thu, 15 Oct 2020 21:41:35 +0200 Content-Disposition: inline In-Reply-To: <83pn5jwav0.fsf@gnu.org> X-Provags-ID: V03:K1:RuYQ8vrUa/rPxJ97yjbxFgi8dpwcG2fvhr7MYsXMVjdtRARjaov K3aEIIjBKCq3/Q0vc1jrjYcHg6ghe3PvjFOoNhTH/kEGMb+VBykR+Vj7xrIZRK5CeoOkJh9 vDNWMkDcIK0CUPKaF57jsU+QDpj+SAeWGuieCAhfxAXsWHqcstvg14ysygZpsc++5HA/NhW 2CgY2DzBkvfScE3WBQxQA== X-UI-Out-Filterresults: notjunk:1;V03:K0:r9TgmP8+GcI=:QeSpvkJQqvi5+vTZYa+ZSH z92J5MjHZ6SutNXNKGdX+g/jPS8BNuXIWBRTTnOpsUfZw4hEuyz61yNVxp+Uq1w/J2+ECOslE gD+voZkPmDEPq2iWb4KBQpTcWBQvBjawiwUdi0XL/bNPmEtqidp7Z5GkpWrGHjYHgOrxzgBi1 IOCKF9xS+IwLQE3SqueMgtPTtRHEj7H0FxAPtT0ieUgANF7lSz007qZ51ZUL9YB0rN5+QCxRW RsooinnCMZm4pkEctQCzTcRo1qZ7MYRsl5UQ4Kri5ZPypQZfeKpYGLFi9QHC1OPKjisrtqlEe vFeRc+B3ba2DutWyJXLI4TJ0HpEJP5JcLiYYVywqvoYFDuAmRTQnWCTPxpl3oU3wyuG/dqDuh bkdN4ImbndlobRnT9eqbSN3K39SDpxzAnxl7qto56KlWdGkQHlPk2ptlniUhKfYby9txHJ7Zn AOm5AP2PusU20AKSe8VmuLV/1rK/DZatEzb0gmensAkLBnJBqaFtozxG1Rli7G4f8rofG5s4t MDYAoWyigAntq/dk45MUyqKo/Thl8yMl4y+hvbb0pevfRgLaxoLDwgHUpSbkjiriqb5lGr1ZI 2o/q/nA/xCYPP9DkHBkE9KY1Y9ALGg9RupOto1jF2Hnepi08KpDZlt8XNxJP2dgNEuPAM3Oy3 F5pRPI24BRHxVXMeFPoQkRaP9Qw6sF/CU50V8EqCOe04d+UsyNZoOu50iBDMmMPZza0TDmtS6 XBdNcWVNLli93jgdVktfV3a+KTNnb6cCcmHlo+q8VEvmPnTTIJbbALQQQdKTh8BgGsRqttyb Received-SPF: pass client-ip=212.227.17.21; envelope-from=boruch_baum@gmx.com; helo=mout.gmx.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/15 14:54:02 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-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:257761 Archived-At: On 2020-10-15 22:24, Eli Zaretskii wrote: > Thanks. Does this do more/different things than "C-h P"? AFAIK, > "C-h P" also uses the commentary part of a package's source file. If > something is missing there, perhaps we could add or extend what > "C-h P" does? 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. =2D- hkp://keys.gnupg.net CA45 09B5 5351 7C11 A9D1 7286 0036 9E45 1595 8BC0