Mercurial > octave-nkf
comparison scripts/strings/strsplit.m @ 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 | d63878346099 |
children | 446c46af4b42 |
comparison
equal
deleted
inserted
replaced
18181:5eb00651e977 | 18185:1874a5a142ee |
---|---|
20 ## @deftypefn {Function File} {[@var{cstr}] =} strsplit (@var{s}) | 20 ## @deftypefn {Function File} {[@var{cstr}] =} strsplit (@var{s}) |
21 ## @deftypefnx {Function File} {[@var{cstr}] =} strsplit (@var{s}, @var{del}) | 21 ## @deftypefnx {Function File} {[@var{cstr}] =} strsplit (@var{s}, @var{del}) |
22 ## @deftypefnx {Function File} {[@var{cstr}] =} strsplit (@dots{}, @var{name}, @var{value}) | 22 ## @deftypefnx {Function File} {[@var{cstr}] =} strsplit (@dots{}, @var{name}, @var{value}) |
23 ## @deftypefnx {Function File} {[@var{cstr}, @var{matches}] =} strsplit (@dots{}) | 23 ## @deftypefnx {Function File} {[@var{cstr}, @var{matches}] =} strsplit (@dots{}) |
24 ## Split the string @var{s} using the delimiters specified by @var{del} | 24 ## Split the string @var{s} using the delimiters specified by @var{del} |
25 ## and return a cell-string array of sub-strings. If a delimiter is not | 25 ## and return a cell string array of substrings. If a delimiter is not |
26 ## specified the string, @var{s}, is split at whitespace. The delimiter, | 26 ## specified the string, @var{s}, is split at whitespace. The delimiter, |
27 ## @var{del} may be a string, a scalar cell-string, or cell-string array. | 27 ## @var{del} may be a string, a scalar cell string, or cell string array. |
28 ## @var{del} must be a cell-string array. By default, consecutive | 28 ## By default, consecutive delimiters in the input string @var{s} are |
29 ## delimiters in the input string, @var{s}, are collapsed into one. | 29 ## collapsed into one. |
30 ## | 30 ## |
31 ## The second output, @var{matches}, returns the delmiters which were matched | 31 ## The second output, @var{matches}, returns the delimiters which were matched |
32 ## in the original string. | 32 ## in the original string. |
33 ## | 33 ## |
34 ## Example: | 34 ## Example: |
35 ## | 35 ## |
36 ## @example | 36 ## @example |