unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefankangas@gmail.com>
To: "Mattias Engdegård" <mattias.engdegard@gmail.com>, 72829@debbugs.gnu.org
Cc: steve@sanityinc.com, Stefan Monnier <monnier@iro.umontreal.ca>
Subject: bug#72829: describe-function NEWS* scraper override
Date: Sat, 31 Aug 2024 15:26:58 -0700	[thread overview]
Message-ID: <CADwFkmmxyg4s1HLTFit-kVvVrN0KEgjNr+nKCHC2n9A7+1+KUQ@mail.gmail.com> (raw)
In-Reply-To: <79C79924-4870-4E55-9920-3D2C08A1E765@gmail.com>

Mattias Engdegård <mattias.engdegard@gmail.com> writes:

> `describe-function` sometimes gives incorrect information about when
> certain functions were first introduced. NEWS.unknown can be used to
> fix some problems but it only works in one direction and is unable to
> help when a function name appears too early.
>
> A robust solution would be to make NEWS* use a mark-up like
> @function{some-name} instead of just 'some-name' but meanwhile, here
> is a simple patch that replaces NEWS.unknown with a more structured
> file. This fixes the case for `always`.

This is a welcome change.

For symbols that are in symbol-releases.eld, which means we are actually
sure about the addition, shouldn't the help text be changed from

    Probably introduced at or before Emacs version XX.Y.

to something more like

    Added in Emacs version XX.Y.

?  I mean, we should be sure about what we put in that file, presumably.

Steve Purcell (in Cc) has been maintaining a relatively complete symbol
to version database here:

    https://github.com/purcell/package-lint/blob/master/data/stdlib-changes

Note that his version keeps track of also of `feature`s, and not just
additions but removals as well.  It would be nice if our version could
be extended to do the same.  Perhaps Steve has some code or ideas that
he would be willing to contribute.





  parent reply	other threads:[~2024-08-31 22:26 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-27 11:35 bug#72829: describe-function NEWS* scraper override Mattias Engdegård
2024-08-31 10:10 ` Eli Zaretskii
2024-08-31 14:06   ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-08-31 17:13   ` Mattias Engdegård
2024-08-31 17:43     ` Eli Zaretskii
2024-08-31 22:26 ` Stefan Kangas [this message]
2024-09-01  1:20   ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-09-01  4:52   ` Eli Zaretskii
2024-09-01 12:01   ` Mattias Engdegård
2024-09-09 14:43     ` Steve Purcell

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=CADwFkmmxyg4s1HLTFit-kVvVrN0KEgjNr+nKCHC2n9A7+1+KUQ@mail.gmail.com \
    --to=stefankangas@gmail.com \
    --cc=72829@debbugs.gnu.org \
    --cc=mattias.engdegard@gmail.com \
    --cc=monnier@iro.umontreal.ca \
    --cc=steve@sanityinc.com \
    /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).