From: Ihor Radchenko <yantar92@posteo.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 59275@debbugs.gnu.org
Subject: bug#59275: Unexpected return value of `string-collate-lessp' on Mac
Date: Thu, 24 Nov 2022 02:22:41 +0000 [thread overview]
Message-ID: <87wn7lay6m.fsf@localhost> (raw)
In-Reply-To: <835yf5zpir.fsf@gnu.org>
Eli Zaretskii <eliz@gnu.org> writes:
>> Should we update the manual as well?
>> 4.5 Comparison of Characters and Strings section contains the old
>> docstring verbatim.
>
> I see in the manual text that is not a verbatim copy of the doc string, but
> an expanded version of it with more detailed explanations. Which is how it
> should be: it is IMNSHO bad documentation-fu to have the manual just copycat
> the doc strings. (We sometimes do it for lack of time, but it is not a Good
> Thing.)
Fair point.
> The note about case-sensitivity of the fallback was missing from the manual,
> so I added it.
Thanks!
>> P.S. I am wondering if there is some automated way to deal with verbatim
>> docstrings in the manuals. They are so easy to slip through when the
>> Elisp docstrings get updated.
>
> 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?
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2022-11-24 2:22 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 [this message]
2022-11-24 7:23 ` Eli Zaretskii
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87wn7lay6m.fsf@localhost \
--to=yantar92@posteo.net \
--cc=59275@debbugs.gnu.org \
--cc=eliz@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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.