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: Fri, 16 Oct 2020 03:34:32 -0400 [thread overview]
Message-ID: <20201016073432.4bmahi4jna2xxayl@E15-2016.optimum.net> (raw)
In-Reply-To: <83imbawu6y.fsf@gnu.org>
On 2020-10-16 09:39, Eli Zaretskii wrote:
> 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.
1) I share the sentiment about consolidating the help/describe commands,
and have no objection to the feature being accessed via a link in
describe-package (ie. no direct dedicated keybinding).
1.1) The output of the proof-of-concept code (for now I'll call it
pack-doc, though I don't like the name) can kind of act as a
surrogate for a package's info manual, so it might make sense to
also have an entry point somehow from that angle, but I don't
have an idea for how to do that.
1.2) The output is also meant to be useful for emacs developers and
bug-fixers, in that the org-mode format allows them get a
birds-eye view of the symbol landscape, and easily navigate
about, swooping in and out to view docstrings.
1.2.1) For this target audience, it might be desirable to
include the actual lisp code in sub-sub-headings or in
collapsed code blocks, but that might confuse other users
/ audiences.
2) I do have a personal agenda with this proposal, and I want to be
explicit about it.
2.1) Make it easier for emacs code contributors to document their
work to best user effect and with least programmer effort /
duplication.
2.2) Encourage literate programming in elisp files beyond simply
docstrings. I see many package files that are conscientiously
documented, yet also see many core-emacs packages whose
documentation amount to just stubs.
3) pack-doc can operate on any elisp file that complies with emacs
coding standards, even if it isn't on the package list and doesn't
show up as a completion option for describe-package. In testing, I
discovered dired.el as an example of a file that would be of interest
but couldn't be accessed with the current method used by
describe-package. Some options for such cases:
2.1) Change the completion/input code for describe-package (con: messy).
2.2) Allow direct interactive access to the feature, but without a
keybinding (con: adds another obscure feature).
4) Have you (or anyone on the list, don't be shy) tried it on an el file?
--
hkp://keys.gnupg.net
CA45 09B5 5351 7C11 A9D1 7286 0036 9E45 1595 8BC0
next prev parent reply other threads:[~2020-10-16 7:34 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
2020-10-16 6:39 ` Eli Zaretskii
2020-10-16 7:34 ` Boruch Baum [this message]
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201016073432.4bmahi4jna2xxayl@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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).