Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED]

[Boruch Baum <boruch_baum@gmx.com>]

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