diff scripts/io/strread.m @ 20136:e51473fdb622

doc: Periodic grammarcheck of documentation. * func.txi, io.txi, error.cc, file-io.cc, regexp.cc, utils.cc, variables.cc, dlmwrite.m, strread.m, textread.m, textscan.m: Use @xbackslashchar to produce a backslash and resolve differences between Info viewer and pdf view. * warning_ids.m: Use @option around command line options. * qmr.m: Use @nospell macro for names in citation. * genpropdoc.m: Eliminate trailing space to closing '}'.
author Rik <rik@octave.org>
date Sun, 19 Apr 2015 17:55:33 -0700
parents f68c3a62e42c
children 03b9d17a2d95
line wrap: on
line diff
--- a/scripts/io/strread.m	Sun Apr 19 18:41:08 2015 -0400
+++ b/scripts/io/strread.m	Sun Apr 19 17:55:33 2015 -0700
@@ -147,8 +147,10 @@
 ## @item @qcode{"whitespace"}
 ## Any character in @var{value} will be interpreted as whitespace and
 ## trimmed; the string defining whitespace must be enclosed in double
-## quotes for proper processing of special characters like \t.
-## The default value for whitespace = @qcode{" \b\r\n\t"} (note the space).
+## quotes for proper processing of special characters like
+## @qcode{"@xbackslashchar{}t"}.  The default value for whitespace is
+## @qcode{" @xbackslashchar{}b@xbackslashchar{}r@xbackslashchar{}n@xbackslashchar{}t"}
+## (note the space).
 ## Unless whitespace is set to '' (empty) AND at least one @qcode{"%s"} format
 ## conversion specifier is supplied, a space is always part of whitespace.
 ##
@@ -159,11 +161,11 @@
 ## depends on the last character of @var{str}:
 ##
 ## @table @asis
-## @item last character = @qcode{"\n"}
+## @item last character = @qcode{"@xbackslashchar{}n"}
 ## Data columns are padded with empty fields or Nan so that all columns
 ## have equal length
 ##
-## @item last character is not @qcode{"\n"}
+## @item last character is not @qcode{"@xbackslashchar{}n"}
 ## Data columns are not padded; strread returns columns of unequal length
 ##
 ## @end table