]> git.eshelyaron.com Git - emacs.git/commitdiff
Fix documentation of 'string-pad'
authorEli Zaretskii <eliz@gnu.org>
Sat, 28 May 2022 07:55:01 +0000 (10:55 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sat, 28 May 2022 07:55:01 +0000 (10:55 +0300)
* doc/lispref/strings.texi (Creating Strings): Fix description of
'string-pad'.  (Bug#55688)

doc/lispref/strings.texi

index 2810f686eb7ee6026320009efbab79be124475f3..3d8db985e9cfd88c510baca536ad75353814149a 100644 (file)
@@ -440,12 +440,12 @@ Split @var{string} into a list of strings on newline boundaries.  If
 @end defun
 
 @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.
+Pad @var{string} to be of the given @var{length} using @var{padding}
+as the padding character.  @var{padding} defaults to the space
+character.  If @var{string} is longer than @var{length}, no padding is
+done.  If @var{start} is @code{nil} or omitted, the padding is
+appended to the characters of @var{string}, and if it's
+non-@code{nil}, the padding is prepended to @var{string}'s characters.
 @end defun
 
 @defun string-chop-newline string