changeset 17753:887df64e54e4

doc: Final grammarcheck of docstrings for 3.8 release. * libinterp/corefcn/debug.cc, scripts/image/imshow.m, scripts/miscellaneous/edit.m, scripts/signal/fftfilt.m: Final grammarcheck of docstrings for 3.8 release.
author Rik <rik@octave.org>
date Thu, 24 Oct 2013 13:49:01 -0700
parents 031eaa90064e
children dffb1e9a6d3b
files libinterp/corefcn/debug.cc scripts/image/imshow.m scripts/miscellaneous/edit.m scripts/signal/fftfilt.m
diffstat 4 files changed, 6 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/debug.cc	Thu Oct 24 13:34:51 2013 -0700
+++ b/libinterp/corefcn/debug.cc	Thu Oct 24 13:49:01 2013 -0700
@@ -1235,7 +1235,7 @@
 With optional argument @var{n}, omit the @var{n} innermost stack frames.\n\
 \n\
 Although accepted, the argument @var{-completenames} is silently ignored.\n\
-Octave always returns absolute file names. The arguments @var{n} and\n\
+Octave always returns absolute file names.  The arguments @var{n} and\n\
 @var{-completenames} can be both specified in any order.\n\
 \n\
 The optional return argument @var{stack} is a struct array with the\n\
--- a/scripts/image/imshow.m	Thu Oct 24 13:34:51 2013 -0700
+++ b/scripts/image/imshow.m	Thu Oct 24 13:49:01 2013 -0700
@@ -46,13 +46,13 @@
 ## @item @qcode{"displayrange"}
 ## @var{value1} is the display range as described above.
 ## 
-## @item "xdata"
+## @item @qcode{"xdata"}
 ## If @var{value1} is a two element vector, it must contain horizontal axis
 ## limits in the form [xmin xmax]; Otherwise @var{value1} must be a
 ## vector and only the first and last elements will be used for xmin and
 ## xmax respectively.
 ## 
-## @item "ydata"
+## @item @qcode{"ydata"}
 ## If @var{value1} is a two element vector, it must contain vertical axis
 ## limits in the form [ymin ymax]; Otherwise @var{value1} must be a
 ## vector and only the first and last elements will be used for ymin and
--- a/scripts/miscellaneous/edit.m	Thu Oct 24 13:34:51 2013 -0700
+++ b/scripts/miscellaneous/edit.m	Thu Oct 24 13:49:01 2013 -0700
@@ -44,14 +44,14 @@
 ## @item
 ## If @code{@var{name}.cc} is specified, then it will search for
 ## @code{@var{name}.cc} in the path and try to modify it, otherwise it will
-## create a new @file{.cc} file in the current directory. If @var{name} happens
+## create a new @file{.cc} file in the current directory.  If @var{name} happens
 ## to be an m-file or interpreter defined function, then the text of that
 ## function will be inserted into the .cc file as a comment.
 ##
 ## @item
 ## If @file{@var{name}.ext} is on your path then it will be edited, otherwise
 ## the editor will be started with @file{@var{name}.ext} in the current
-## directory as the filename. If @file{@var{name}.ext} is not modifiable,
+## directory as the filename.  If @file{@var{name}.ext} is not modifiable,
 ## it will be copied to @env{HOME} before editing.
 ##
 ## @strong{Warning:} You may need to clear @var{name} before the new definition
--- a/scripts/signal/fftfilt.m	Thu Oct 24 13:34:51 2013 -0700
+++ b/scripts/signal/fftfilt.m	Thu Oct 24 13:49:01 2013 -0700
@@ -25,7 +25,7 @@
 ##
 ## Given the optional third argument, @var{n}, @code{fftfilt} uses the
 ## overlap-add method to filter @var{x} with @var{b} using an N-point
-## FFT.  The FFT size must be an even power of 2 and must be greater than
+## FFT@.  The FFT size must be an even power of 2 and must be greater than
 ## or equal to the length of @var{b}.  If the specified @var{n} does not
 ## meet these criteria, it is automatically adjusted to the nearest value
 ## that does.