From: Drew Adams <drew.adams@oracle.com>
To: chrisdone@googlemail.com
Cc: emacs-devel@gnu.org
Subject: RE: Support for bringing package change logs to the user's attention
Date: Fri, 25 May 2018 07:26:23 -0700 (PDT) [thread overview]
Message-ID: <e5f8883c-d961-4bea-9a9e-515725b97000@default> (raw)
In-Reply-To: <CAAJHNPA5y=0nxwT-__GzEfQNEg0P=r_YV3qBXCwCx5xvB7XS5w@mail.gmail.com>
> Sorry, the obvious approach of simply opening the CHANGELOG file
> would absolutely be sufficient here. No parsing neccessary if
> we do that. Changelogs are usually written in descending order.
I like a `;;; Change Log:' entry in an Elisp file (or
in a separate file, in the case of a multi-file Elisp
package). IOW, I'm in favor of change-log histories,
whether in the code-files themselves, as separate files,
or recorded in a vc system.
However, I think there was a lot more in your first
message. You made some good suggestions and posed some
good questions, which are worth thinking about - they go
beyond just pointing users to existing development change
logs.
I'm in favor, for example, of providing users with a quick
What's New view of the delta from either the last available
version or the last version that the given user has. And
doing so from both a code-changes point of view and a
feature/behavior-changes point of view.
Ideally, we'd provide different ways for a user to see
what's changed, between an arbitrary two points in the
evolution, and at different granularities of view.
The granularity thing is important for users: a
development change-log entry does not necessarily
express the effect of a change from a user point of
view. Some reading between the lines and rumination
are needed (along with some trial and error), to
discover what's really changed.
IOW, change logs are great for implementors, but they
are not the only, and not often the best, way for
users to see what's changed.
No, I don't have any particular ideas about what might
be done to help users here.
But yes, I think there's lots of room for helping.
Emacs has a great user-help system, in general. But
it doesn't yet offer much to help users see what's
new or what's changed.
Discovery is not just a one-time, newbie/novice thing
for a given feature. It's a recurring thing: discover
what's changed and how it affects your use of Emacs
and what you can do with it.
next prev parent reply other threads:[~2018-05-25 14:26 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-25 11:47 Support for bringing package change logs to the user's attention Christopher Done
2018-05-25 11:50 ` Christopher Done
2018-05-25 14:26 ` Drew Adams [this message]
2018-05-25 14:31 ` Aaron Ecay
2018-05-25 16:40 ` Eric Abrahamsen
2018-05-25 17:16 ` Noam Postavsky
2018-05-25 17:51 ` Eric Abrahamsen
2018-05-26 21:07 ` Stefan Monnier
2018-05-26 21:48 ` Eric Abrahamsen
2018-05-26 21:59 ` Stefan Monnier
2018-05-27 3:15 ` Van L
2018-05-28 20:34 ` John Wiegley
2018-06-26 17:59 ` Ted Zlatanov
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=e5f8883c-d961-4bea-9a9e-515725b97000@default \
--to=drew.adams@oracle.com \
--cc=chrisdone@googlemail.com \
--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).