]> git.eshelyaron.com Git - emacs.git/commitdiff
(Creating Strings): Clarify split-string.
authorRichard M. Stallman <rms@gnu.org>
Wed, 28 May 2003 11:35:48 +0000 (11:35 +0000)
committerRichard M. Stallman <rms@gnu.org>
Wed, 28 May 2003 11:35:48 +0000 (11:35 +0000)
lispref/strings.texi

index 635aca08fe7282669411e687302b16e1fd57ec0a..681e76daea97c57cee44899147bb2ce231a64e7d 100644 (file)
@@ -260,12 +260,18 @@ Lists}.
 @end defun
 
 @defun split-string string separators omit-nulls
-This function splits @var{string} into substrings at matches for the regular
-expression @var{separators}.  Each match for @var{separators} defines a
-splitting point; the substrings between the splitting points are made
-into a list, which is the value returned by @code{split-string}.  If
-@var{omit-nulls} is @code{t}, null strings will be removed from the
-result list.  Otherwise, null strings are left in the result.
+This function splits @var{string} into substrings at matches for the
+regular expression @var{separators}.  Each match for @var{separators}
+defines a splitting point; the substrings between the splitting points
+are made into a list, which is the value returned by
+@code{split-string}.
+
+If @var{omit-nulls} is @code{nil}, the result contains null strings
+whenever there are two consecutive matches for @var{separators}, or a
+match is adjacent to the beginning or end of @var{string}.  If
+@var{omit-nulls} is @code{t}, these null strings are omitted from the
+result list.
+
 If @var{separators} is @code{nil} (or omitted),
 the default is the value of @code{split-string-default-separators}.