all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefankangas@gmail.com>
To: Boruch Baum <boruch_baum@gmx.com>,
	Stefan Monnier <monnier@iro.umontreal.ca>
Cc: Eli Zaretskii <eliz@gnu.org>, emacs-devel@gnu.org
Subject: Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED]
Date: Sun, 18 Oct 2020 08:50:55 -0700	[thread overview]
Message-ID: <CADwFkm=SZA2pDaT+_=ze9Jofwfy=J6TeYuLf14ButM6uEqQe0g@mail.gmail.com> (raw)
In-Reply-To: <20201018144345.wgrbsivvzuuohbj5@E15-2016.optimum.net>

Boruch Baum <boruch_baum@gmx.com> writes:

>> IOW what would be the advantage of adding a link in `C-h P` to your
>> system, instead of just replacing `C-h P` with your system?
>
> IMO: Just losing the heading summary, but that code can be integrated so
> that nothing would be lost.

Having tested your code, I agree that we should keep `C-h P' as-is, but
extend it with everything from the "** Code:" header and down in your
code.  (I guess that part could be collapsed by default in order to not
overwhelm a user with details?)  It would be great if one could also
collapse the "Commentary" section.  I would also give it a headline
"Description:" using the same font as "Status:".

We would also need to check that this works also for packages that are
not installed (they don't need to show the full documentation, I don't
think, but they should at least not be broken ;-).

Bonus points if we can also add a link to the relevant Info manual,
where there is one.

BTW, does this all really need to be based on Org-mode?  Perhaps one
could make it look more polished by rolling a custom solution here, and
I'm not exactly sure what using Org-mode buys us in this case.

Three more nits:
- I wouldn't show obsolete aliases.
- The autoload cookies should probably get a better representation than
  just being copied in.
- The doc strings should be passed to `substitute-command-keys' before
  display.



  reply	other threads:[~2020-10-18 15:50 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
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 [this message]
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='CADwFkm=SZA2pDaT+_=ze9Jofwfy=J6TeYuLf14ButM6uEqQe0g@mail.gmail.com' \
    --to=stefankangas@gmail.com \
    --cc=boruch_baum@gmx.com \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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.