From: Boruch Baum <boruch_baum@gmx.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED]
Date: Thu, 15 Oct 2020 15:41:32 -0400 [thread overview]
Message-ID: <20201015194132.jdn3e2v62vfvh7ju@E15-2016.optimum.net> (raw)
In-Reply-To: <83pn5jwav0.fsf@gnu.org>
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.
--
hkp://keys.gnupg.net
CA45 09B5 5351 7C11 A9D1 7286 0036 9E45 1595 8BC0
next prev parent reply other threads:[~2020-10-15 19:41 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-15 19:09 ~Make emacs friendlier: package documentation [POC CODE INCLUDED] Boruch Baum
2020-10-15 19:24 ` Eli Zaretskii
2020-10-15 19:41 ` Boruch Baum [this message]
2020-10-16 6:39 ` Eli Zaretskii
2020-10-16 7:34 ` Boruch Baum
2020-10-16 10:20 ` Eli Zaretskii
2020-10-18 5:58 ` Boruch Baum
2020-10-18 14:53 ` Eli Zaretskii
2020-10-18 15:05 ` Boruch Baum
2020-10-18 15:12 ` Eli Zaretskii
2020-10-18 15:28 ` Boruch Baum
2020-10-18 16:00 ` Eli Zaretskii
2020-10-18 16:29 ` Boruch Baum
2020-10-18 17:05 ` Eli Zaretskii
2020-10-18 13:11 ` Stefan Monnier
2020-10-18 14:43 ` Boruch Baum
2020-10-18 15:50 ` Stefan Kangas
2020-10-18 16:20 ` Boruch Baum
2020-10-18 17:13 ` Stefan Kangas
2020-10-18 20:40 ` Kévin Le Gouguec
2020-10-19 2:55 ` Boruch Baum
2020-10-21 5:52 ` Kévin Le Gouguec
2020-10-21 6:00 ` Boruch Baum
2020-10-21 22:31 ` Stefan Monnier
2020-10-18 15:58 ` Boruch Baum
2020-10-18 20:18 ` Stefan Monnier
2020-10-19 2:24 ` Eli Zaretskii
2020-10-19 2:59 ` Boruch Baum
2020-10-19 3:16 ` Stefan Monnier
2020-10-20 5:11 ` Richard Stallman
2020-10-20 5:51 ` Boruch Baum
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201015194132.jdn3e2v62vfvh7ju@E15-2016.optimum.net \
--to=boruch_baum@gmx.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.