changeset 2138:2f37290328b0

[xemacs-hg @ 2004-06-17 11:29:37 by stephent] docstring kaizen <87k6y6l8zy.fsf@tleepslib.sk.tsukuba.ac.jp>
author stephent
date Thu, 17 Jun 2004 11:29:39 +0000
parents 67e24d0cc80f
children fd22900227d7
files lisp/ChangeLog lisp/subr.el
diffstat 2 files changed, 10 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/ChangeLog	Thu Jun 17 11:23:11 2004 +0000
+++ b/lisp/ChangeLog	Thu Jun 17 11:29:39 2004 +0000
@@ -1,3 +1,7 @@
+2004-06-09  Stephen J. Turnbull  <stephen@xemacs.org>
+
+	* subr.el (split-string): Clean up docstring.
+
 2004-06-17  Stephen J. Turnbull  <stephen@xemacs.org>
 
 	* help.el (with-syntax-table): Removed.  (Prefer version in subr.el.)
--- a/lisp/subr.el	Thu Jun 17 11:23:11 2004 +0000
+++ b/lisp/subr.el	Thu Jun 17 11:29:39 2004 +0000
@@ -669,14 +669,14 @@
 the substrings between the splitting points are collected as a list,
 which is returned.
 
-If SEPARATORS is non-nil, it should be a regular expression matching text
-which separates, but is not part of, the substrings.  If nil it defaults to
+If SEPARATORS is non-`nil', it should be a regular expression matching text
+which separates, but is not part of, the substrings.  If `nil' it defaults to
 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
-OMIT-NULLS is forced to t.
+OMIT-NULLS is forced to `t'.
 
-If OMIT-NULLs is t, zero-length substrings are omitted from the list \(so
+If OMIT-NULLS is `t', zero-length substrings are omitted from the list \(so
 that for the default value of SEPARATORS leading and trailing whitespace
-are effectively trimmed).  If nil, all zero-length substrings are retained,
+are effectively trimmed).  If `nil', all zero-length substrings are retained,
 which correctly parses CSV format, for example.
 
 Note that the effect of `(split-string STRING)' is the same as
@@ -684,7 +684,7 @@
 case that you wish to retain zero-length substrings when splitting on
 whitespace, use `(split-string STRING split-string-default-separators nil)'.
 
-Modifies the match data; use `save-match-data' if necessary."
+Modifies the match data when successful; use `save-match-data' if necessary."
 
   (let ((keep-nulls (not (if separators omit-nulls t)))
 	(rexp (or separators split-string-default-separators))