GNU logs - #52985, boring messages

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#52985: describe-package should show README instead of "Commentary" section
Resent-From: Stefan Kangas <stefan@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Mon, 03 Jan 2022 19:15:01 +0000
Resent-Message-ID: <handler.52985.B.164123724319366 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 52985 <at> debbugs.gnu.org
From: Stefan Kangas <stefan@HIDDEN>
MIME-Version: 1.0
Date: Mon, 3 Jan 2022 14:13:56 -0500
Message-ID: <CADwFkmncFSDCkXBeqF4FEsWZYigC4+9TrYScb4VVXx7cHoWnBw@HIDDEN>
Content-Type: text/plain; charset="UTF-8"
Received-SPF: pass client-ip=209.85.215.171;
 envelope-from=stefankangas@HIDDEN; helo=mail-pg1-f171.google.com
X-Spam_score_int: 5
X-Spam_score: 0.5
X-Spam_bar: /
X-Spam_report: (0.5 / 5.0 requ) FREEMAIL_FORGED_FROMDOMAIN=0.249,
 FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.25,
 RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=no autolearn_force=no
X-Spam_action: no action
X-Spam-Score: -0.8 (/)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.8 (-)

Severity: wishlist

It would be more useful if `M-x describe-package' would show the README
file than the "Commentary" section, for packages where such a file
exists.

For the overwhelming majority of third-party packages, the README file,
when it exists, is much better maintained than the "Commentary" section.
Very few people bother keeping the two in sync, so usually what happens
is that the file commentary is pretty useless, and you need to go to the
Homepage/URL to even know how to use the package.

Too often this means you need to visit GitHub in your web browser.  One
could perhaps argue that this is a bug in those packages, but there are
literally thousands of them, and AFAICT little interest in doing things
differently among package authors and users.  Reading on GitHub is fine,
so why bother?

This state of affairs seems suboptimal.  However, I think the above
change could make reading documentation in Emacs more pleasant and
better than reading it externally.

Showing the raw source is unlikely to be very pleasant, so this might
need us to render not just org files in an attractive way, but also
markdown files.  Maybe we could start with showing the raw README files,
then add org-mode (README.org) and markdown (README.md) support, etc.,
later.

Perhaps we could even show the included images, somehow.

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Stefan Kangas <stefan@HIDDEN>
Subject: bug#52985: Acknowledgement (describe-package should show README
 instead of "Commentary" section)
Message-ID: <handler.52985.B.164123724319366.ack <at> debbugs.gnu.org>
References: <CADwFkmncFSDCkXBeqF4FEsWZYigC4+9TrYScb4VVXx7cHoWnBw@HIDDEN>
X-Gnu-PR-Message: ack 52985
X-Gnu-PR-Package: emacs
Reply-To: 52985 <at> debbugs.gnu.org
Date: Mon, 03 Jan 2022 19:15:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 52985 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
52985: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D52985
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#52985: describe-package should show README instead of "Commentary" section
Resent-From: Lars Ingebrigtsen <larsi@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Fri, 14 Jan 2022 08:43:02 +0000
Resent-Message-ID: <handler.52985.B52985.16421497724709 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Stefan Kangas <stefan@HIDDEN>
Cc: 52985 <at> debbugs.gnu.org, Stefan Monnier <monnier@HIDDEN>
From: Lars Ingebrigtsen <larsi@HIDDEN>
References: <CADwFkmncFSDCkXBeqF4FEsWZYigC4+9TrYScb4VVXx7cHoWnBw@HIDDEN>
Date: Fri, 14 Jan 2022 09:42:39 +0100
In-Reply-To: <CADwFkmncFSDCkXBeqF4FEsWZYigC4+9TrYScb4VVXx7cHoWnBw@HIDDEN>
 (Stefan Kangas's message of "Mon, 3 Jan 2022 14:13:56 -0500")
Message-ID: <874k66r9mo.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Stefan Kangas <stefan@HIDDEN> writes:

> It would be more useful if `M-x describe-package' would show the README
> file than the "Commentary" section, for packages where such a file
> exists.

Makes sense to me.

> Perhaps we could even show the included images, somehow.

Yes, that would be nice.

I've added Stefan M to the CCs; perhaps he has some comments here.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Last modified: Fri, 14 Jan 2022 08:45:01 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.