]> git.eshelyaron.com Git - emacs.git/commitdiff
; Fix doc string of 'lsh'
authorEli Zaretskii <eliz@gnu.org>
Fri, 15 Sep 2023 07:17:30 +0000 (10:17 +0300)
committerEli Zaretskii <eliz@gnu.org>
Fri, 15 Sep 2023 07:17:30 +0000 (10:17 +0300)
* lisp/subr.el (lsh): Doc fix.  Suggested by Richard Stallman
<rms@gnu.org>.

lisp/subr.el

index 426e8145cae4ad18d61bfea94ad7fdc3bc348460..d5c461346cbd0fc0a57150170dc51393d209f6e2 100644 (file)
@@ -507,8 +507,10 @@ If COUNT is negative, shifting is actually to the right.
 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.
 
-This function is provided for compatibility.  In new code, use `ash'
-instead."
+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."
   (declare (compiler-macro
             (lambda (form)
               (macroexp-warn-and-return "avoid `lsh'; use `ash' instead"