From: Ulrich Mueller <ulm@gentoo.org>
To: emacs-devel@gnu.org
Subject: lsh function documentation
Date: Tue, 30 Jan 2024 12:34:59 +0100 [thread overview]
Message-ID: <umssnyrz0@gentoo.org> (raw)
The function documentation of lsh says:
| Most uses of this function turn out to be mistakes. We recommend
| to use ‘ash’ instead, unless COUNT could ever be negative, and
| if, when COUNT is negative, your program really needs the special
| treatment of negative COUNT provided by this function.
I understand that lsh has no useful semantics for negative bignums
(bug #32463). However, old versions of the Lisp Reference Manual list
lsh and ash in the same section, and don't prefer either function:
https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/lispref/numbers.texi?h=emacs-26.3#n811
So why would programmers who had used something like (lsh x 8) in their
code be called out for making a mistake?
Couldn't lsh's documentation just say that the function is deprecated
and that ash should be used instead?
next reply other threads:[~2024-01-30 11:34 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-30 11:34 Ulrich Mueller [this message]
2024-01-31 14:49 ` lsh function documentation Eli Zaretskii
2024-01-31 16:15 ` Ulrich Mueller
2024-01-31 16:48 ` Eli Zaretskii
2024-01-31 17:01 ` Ulrich Mueller
2024-01-31 19:27 ` 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=umssnyrz0@gentoo.org \
--to=ulm@gentoo.org \
--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 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.