[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED]
From: |
Stefan Kangas |
Subject: |
Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED] |
Date: |
Sun, 18 Oct 2020 08:50:55 -0700 |
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.
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], (continued)
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Boruch Baum, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Eli Zaretskii, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Boruch Baum, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Eli Zaretskii, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Boruch Baum, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Eli Zaretskii, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Boruch Baum, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Eli Zaretskii, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Stefan Monnier, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Boruch Baum, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED],
Stefan Kangas <=
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Boruch Baum, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Stefan Kangas, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Kévin Le Gouguec, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Boruch Baum, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Kévin Le Gouguec, 2020/10/21
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Boruch Baum, 2020/10/21
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Stefan Monnier, 2020/10/21
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Boruch Baum, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Stefan Monnier, 2020/10/18
- Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED], Eli Zaretskii, 2020/10/18