Mercurial > hg > octave-terminal
changeset 11150:564e998017f5
docstring fixes
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Sat, 23 Oct 2010 03:33:25 -0400 |
parents | fe3c3dfc07eb |
children | 0c38b45ab49c |
files | scripts/ChangeLog scripts/io/strread.m scripts/strings/strjust.m scripts/strings/untabify.m |
diffstat | 4 files changed, 14 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,8 @@ +2010-10-23 John W. Eaton <jwe@octave.org> + + * strings/untabify.m, strings/strjust.m, io/strread.m: + Docstring fixes. + 2010-10-23 John W. Eaton <jwe@octave.org> * statistics/distributions/nbinrnd.m: Use | instead of || in
--- a/scripts/io/strread.m +++ b/scripts/io/strread.m @@ -19,8 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{a}, @dots{}] =} strread (@var{str}) ## @deftypefnx {Function File} {[@var{a}, @dots{}] =} strread (@var{str}, @var{format}) -## @deftypefnx {Function File} {[@var{a}, @dots{}] =} strread (@var{str}, @var{format}, @ -## @var{prop1}, @var{value1}, @dots{}) +## @deftypefnx {Function File} {[@var{a}, @dots{}] =} strread (@var{str}, @var{format}, @var{prop1}, @var{value1}, @dots{}) ## Read data from a string. ## ## The string @var{str} is split into words that are repeatedly matched to the @@ -95,7 +94,7 @@ ## ## @item "emptyvalue" ## Parts of the output where no word is available is filled with @var{value}. -## @end itemize +## @end table ## ## @seealso{textread, load, dlmread, fscanf} ## @end deftypefn
--- a/scripts/strings/strjust.m +++ b/scripts/strings/strjust.m @@ -18,15 +18,10 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} strjust (@var{s}) -## @deftypefnx {Function File} strjust (@var{s}, "right") -## Returns the text, S, justified to the right. -## -## @deftypefnx {Function File} strjust (@var{s}, "left") -## Returns left justified text. -## -## @deftypefnx {Function File} strjust (@var{s}, "center") -## Returns center justified text. +## @deftypefn {Function File} {} strjust (@var{s}, @var{pos}) +## Return the text, @var{s}, justified according to @var{pos}, which may +## be @samp{"left"}, @samp{"center"}, or @samp{"right"}. If @var{pos} +## is omitted, @samp{"right"} is assumed. ## ## Null characters are replaced by spaces. All other character ## data are treated as non-white space.
--- a/scripts/strings/untabify.m +++ b/scripts/strings/untabify.m @@ -17,9 +17,9 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function file} untabify (@var{t}) -## @deftypefnx {Function file} untabify (@var{t}, @var{tw}) -## @deftypefnx {Function file} untabify (@var{t}, @var{tw}, @var{deblank}) +## @deftypefn {Function file} {} untabify (@var{t}) +## @deftypefnx {Function file} {} untabify (@var{t}, @var{tw}) +## @deftypefnx {Function file} {} untabify (@var{t}, @var{tw}, @var{deblank}) ## Replace TAB characters in @var{t}, with spaces. ## The tab width is specified by @var{tw}, or defaults to eight. ## The input, @var{t}, may be either a 2D character array, or a cell