Improve wording of lsh docstring

* lisp/subr.el (lsh): Improve wording of docstring.
This commit is contained in:
Stefan Kangas 2025-02-22 18:15:37 +01:00
parent 0cc651acdd
commit e15dcb2db5

View file

@ -571,10 +571,10 @@ If COUNT is negative, shifting is actually to the right.
In this case, if VALUE is a negative fixnum treat it as unsigned, In this case, if VALUE is a negative fixnum treat it as unsigned,
i.e., subtract 2 * `most-negative-fixnum' from VALUE before shifting it. i.e., subtract 2 * `most-negative-fixnum' from VALUE before shifting it.
Most uses of this function turn out to be mistakes. We recommend Most uses of this function turn out to be mistakes. We recommend using
to use `ash' instead, unless COUNT could ever be negative, and `ash' instead, unless COUNT could ever be negative, in which case your
if, when COUNT is negative, your program really needs the special program should only use this function if it specifically requires the
treatment of negative COUNT provided by this function." special handling of negative COUNT."
(declare (ftype (function (integer integer) integer)) (declare (ftype (function (integer integer) integer))
(compiler-macro (compiler-macro
(lambda (form) (lambda (form)