Mercurial > octave

changeset 21383:c9f967cfe7c1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Point user to dlmread/dlmwrite in csvread/csvwrite for dlmopts (bug #47309) * csvread.m: Add note about dlmread options to docstring. * csvwrite.m: Add note about dlmread options to docstring.
author Nicholas R. Jankowski <jankowskin@asme.org>
date Tue, 01 Mar 2016 09:00:33 -0800
parents eb7287db3da9
children ad1dbbd23f1d
files scripts/io/csvread.m scripts/io/csvwrite.m
diffstat 2 files changed, 8 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/io/csvread.m	Tue Mar 01 03:25:14 2016 -0500
+++ b/scripts/io/csvread.m	Tue Mar 01 09:00:33 2016 -0800
@@ -18,7 +18,7 @@
 
 ## -*- texinfo -*-
 ## @deftypefn  {} {@var{x} =} csvread (@var{filename})
-## @deftypefnx {} {@var{x} =} csvread (@var{filename}, @var{dlm_opts})
+## @deftypefnx {} {@var{x} =} csvread (@var{filename}, @var{dlm_opt1}, @dots{})
 ## Read the comma-separated-value (CSV) file @var{filename} into the matrix
 ## @var{x}.
 ##
@@ -27,9 +27,11 @@
 ## This function is equivalent to
 ##
 ## @example
-## @var{x} = dlmread (@var{filename}, "," , @dots{})
+## @var{x} = dlmread (@var{filename}, "," , @var{dlm_opt1}, @dots{})
 ## @end example
 ##
+## Any optional arguments are passed directly to @code{dlmread}
+## (@pxref{XREFdlmread,,dlmread}).
 ## @seealso{dlmread, textread, textscan, csvwrite, dlmwrite}
 ## @end deftypefn
 
--- a/scripts/io/csvwrite.m	Tue Mar 01 03:25:14 2016 -0500
+++ b/scripts/io/csvwrite.m	Tue Mar 01 09:00:33 2016 -0800
@@ -18,16 +18,18 @@
 
 ## -*- texinfo -*-
 ## @deftypefn  {} {} csvwrite (@var{filename}, @var{x})
-## @deftypefnx {} {} csvwrite (@var{filename}, @var{x}, @var{dlm_opts})
+## @deftypefnx {} {} csvwrite (@var{filename}, @var{x}, @var{dlm_opt1}, @dots{})
 ## Write the numeric matrix @var{x} to the file @var{filename} in
 ## @w{comma-separated-value} (CSV) format.
 ##
 ## This function is equivalent to
 ##
 ## @example
-## dlmwrite (@var{filename}, @var{x}, ",", @dots{})
+## dlmwrite (@var{filename}, @var{x}, ",", @var{dlm_opt1}, @dots{})
 ## @end example
 ##
+## Any optional arguments are passed directly to @code{dlmwrite}
+## (@pxref{XREFdlmwrite,,dlmwrite}).
 ## @seealso{csvread, dlmwrite, dlmread}
 ## @end deftypefn