From a730d07b4fa1721a3082aea72ea1b5a6d0cf3e4e Mon Sep 17 00:00:00 2001 From: "Richard M. Stallman" Date: Wed, 28 May 2003 11:35:48 +0000 Subject: (Creating Strings): Clarify split-string. --- lispref/strings.texi | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) (limited to 'lispref/strings.texi') diff --git a/lispref/strings.texi b/lispref/strings.texi index 635aca08fe..681e76daea 100644 --- a/lispref/strings.texi +++ b/lispref/strings.texi @@ -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}. -- cgit v1.2.3