bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#55688: Incorrect documentation of "string-pad"


From: emacs
Subject: bug#55688: Incorrect documentation of "string-pad"
Date: Fri, 27 May 2022 18:13:53 -0400

Documentation of "string-pad" function says following (highlighting is
mine).

        @defun string-pad string length &optional padding start

        Pad @var{string} to the be of @var{length} using @var{padding} as the
        padding character (defaulting to the space character).

        If @var{string} is shorter than @var{length}, no padding is done.
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        If @var{start} is @code{nil} (or not present), the padding is done to 
the
        end of the string, and if it's non-@code{nil}, to the start of the
        string.

=> 
https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/lispref/strings.texi#n445

I don't think highlighted line is correct. I matches neither behaviour of
emacs:

        => (string-pad "foo" 12)
        "foo         "

nor what is usually meant by word "padding". I believe issue can be
solved by s/shorter/longer or removing highlighted line at all.





reply via email to

[Prev in Thread] Current Thread [Next in Thread]