changeset 18185:1874a5a142ee stable

doc: Fix documentation for strsplit (bug #41062). * strsplit.m: Remove redundant sentence about delimiter del. Don't use unnecessary hyphen in "cell string array" phrasing. Correct typo of "delmiters". * strjoin.m: Don't use unnecessary hyphen in "cell string array" phrasing.
author Rik <rik@octave.org>
date Wed, 01 Jan 2014 17:54:46 -0800
parents 5eb00651e977
children d638db6d045c
files scripts/strings/strjoin.m scripts/strings/strsplit.m
diffstat 2 files changed, 9 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/strings/strjoin.m	Tue Dec 31 17:04:36 2013 -0500
+++ b/scripts/strings/strjoin.m	Wed Jan 01 17:54:46 2014 -0800
@@ -20,18 +20,18 @@
 ## -*- texinfo -*-
 ## @deftypefn  {Function File} {@var{str} =} strjoin (@var{cstr})
 ## @deftypefnx {Function File} {@var{str} =} strjoin (@var{cstr}, @var{delimiter})
-## Join the elements of the cell-string array, @var{cstr}, into a single
+## Join the elements of the cell string array, @var{cstr}, into a single
 ## string.
 ##
 ## If no @var{delimiter} is specified, the elements of @var{cstr}
 ## separated by a space.
 ##
-## If @var{delimiter} is specified as a string, the cell-string array is
+## If @var{delimiter} is specified as a string, the cell string array is
 ## joined using the string.  Escape sequences are supported.
 ##
-## If @var{delimiter} is a cell-string array whose length is one less
+## If @var{delimiter} is a cell string array whose length is one less
 ## than @var{cstr}, then the elements of @var{cstr} are joined by
-## interleaving the cell-string elements of @var{delimiter}.  Escape
+## interleaving the cell string elements of @var{delimiter}.  Escape
 ## sequences are not supported.
 ##
 ## @example
--- a/scripts/strings/strsplit.m	Tue Dec 31 17:04:36 2013 -0500
+++ b/scripts/strings/strsplit.m	Wed Jan 01 17:54:46 2014 -0800
@@ -22,13 +22,13 @@
 ## @deftypefnx {Function File} {[@var{cstr}] =} strsplit (@dots{}, @var{name}, @var{value})
 ## @deftypefnx {Function File} {[@var{cstr}, @var{matches}] =} strsplit (@dots{})
 ## Split the string @var{s} using the delimiters specified by @var{del}
-## and return a cell-string array of sub-strings.  If a delimiter is not
+## and return a cell string array of substrings.  If a delimiter is not
 ## specified the string, @var{s}, is split at whitespace.  The delimiter,
-## @var{del} may be a string, a scalar cell-string, or cell-string array.
-## @var{del} must be a cell-string array.  By default, consecutive
-## delimiters in the input string, @var{s}, are collapsed into one.
+## @var{del} may be a string, a scalar cell string, or cell string array.
+## By default, consecutive delimiters in the input string @var{s} are
+## collapsed into one.
 ##
-## The second output, @var{matches}, returns the delmiters which were matched
+## The second output, @var{matches}, returns the delimiters which were matched
 ## in the original string.
 ##
 ## Example: