From: Eli Zaretskii <eliz@gnu.org>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: 59275@debbugs.gnu.org
Subject: bug#59275: Unexpected return value of `string-collate-lessp' on Mac
Date: Thu, 24 Nov 2022 09:23:03 +0200 [thread overview]
Message-ID: <83bkowyfxk.fsf@gnu.org> (raw)
In-Reply-To: <87wn7lay6m.fsf@localhost> (message from Ihor Radchenko on Thu, 24 Nov 2022 02:22:41 +0000)
> From: Ihor Radchenko <yantar92@posteo.net>
> Cc: 59275@debbugs.gnu.org
> Date: Thu, 24 Nov 2022 02:22:41 +0000
>
> > There should be no verbatim copies of doc strings in the manual. So I'm not
> > interested in making that bad practice easier ;-)
>
> What about forgetting to update the manual when important changes are
> made to the docstring? I know for certain that it happened many times
> with Org manual. Maybe something can be done to auto-check if updates
> were done to the docstring but not the manual?
That could be a useful feature, suitable for checkdoc.el, perhaps. But
there are 2 issues here that I'm not sure how would such a feature handle:
. not every symbol that has a doc string is mentioned in the manuals
. the doc string and the text in the manual are generally different, and so
it could be that the update to a doc string doesn't require any update to
the manual text
So a naïve implementation would probably have too many false positives. Not
sure if this could render the feature useless.
Bottom line: I'm not sure we can have a good automated way of detecting
updates that were missed, except at patch review time, and that is a
judgment call by the person who does the review, and relies on his/her
vigilance. But if someone could come up with a good way of doing that, it
will be appreciated.
next prev parent reply other threads:[~2022-11-24 7:23 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-15 4:08 bug#59275: Unexpected return value of `string-collate-lessp' on Mac Ihor Radchenko
2022-11-15 9:51 ` Robert Pluim
2022-11-16 3:47 ` Ihor Radchenko
2022-11-15 13:46 ` Eli Zaretskii
2022-11-15 15:05 ` Ihor Radchenko
2022-11-15 15:16 ` Eli Zaretskii
2022-11-16 1:34 ` Ihor Radchenko
2022-11-16 13:00 ` Eli Zaretskii
2022-11-21 7:28 ` Ihor Radchenko
2022-11-21 13:31 ` Eli Zaretskii
2022-11-22 1:24 ` Ihor Radchenko
2022-11-22 12:56 ` Eli Zaretskii
2022-11-23 10:39 ` Ihor Radchenko
2022-11-23 14:58 ` Eli Zaretskii
2022-11-24 2:22 ` Ihor Radchenko
2022-11-24 7:23 ` Eli Zaretskii [this message]
2022-11-26 2:03 ` Ihor Radchenko
2022-11-26 8:06 ` Eli Zaretskii
2022-11-26 8:47 ` Ihor Radchenko
2022-11-26 9:22 ` Eli Zaretskii
2022-11-27 14:00 ` Maxim Nikulin
2022-11-27 14:23 ` Eli Zaretskii
2022-11-27 15:19 ` Maxim Nikulin
2022-11-27 15:42 ` Eli Zaretskii
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=83bkowyfxk.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=59275@debbugs.gnu.org \
--cc=yantar92@posteo.net \
/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).