[Octave-bug-tracker] [bug #52844] small patch for Chapter signal, image, audio, and OOP

[anonymous]

URL:
  <http://savannah.gnu.org/bugs/?52844>

                 Summary: small patch for Chapter signal, image, audio, and
OOP
                 Project: GNU Octave
            Submitted by: None
            Submitted on: Tue 09 Jan 2018 08:45:52 AM UTC
                Category: Documentation
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: address@hidden
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 4.2.1
        Operating System: Any

    _______________________________________________________

Details:


diff -ur a/doc/interpreter/oop.txi b/doc/interpreter/oop.txi
--- a/doc/interpreter/oop.txi
+++ b/doc/interpreter/oop.txi
@@ -423,7 +423,7 @@
 
 Functions that are of particular interest for overloading are the class
 conversion functions such as @code{double}.  Overloading these functions
allows
-the @code{cast} function to work with a user class.  It can also can aid in
the
+the @code{cast} function to work with a user class.  It can also aid in the
 use of a class object with methods and functions from other classes since
the
 object can be transformed to the requisite input form for the new function.
 An example @code{double} function for the polynomial class might look like
diff -ur a/libinterp/corefcn/fft2.cc b/libinterp/corefcn/fft2.cc
--- a/libinterp/corefcn/fft2.cc
+++ b/libinterp/corefcn/fft2.cc
@@ -171,7 +171,7 @@
 size of @var{A}, @var{A} is resized and padded with zeros.
 
 If @var{A} is a multi-dimensional matrix, each two-dimensional sub-matrix
-of @var{A} is treated separately
+of @var{A} is treated separately.
 @seealso{fft2, ifft, ifftn, fftw}
 @end deftypefn */)
 {
diff -ur a/libinterp/corefcn/fft.cc b/libinterp/corefcn/fft.cc
--- a/libinterp/corefcn/fft.cc
+++ b/libinterp/corefcn/fft.cc
@@ -186,7 +186,7 @@
 @deftypefn  {} {} fft (@var{x})
 @deftypefnx {} {} fft (@var{x}, @var{n})
 @deftypefnx {} {} fft (@var{x}, @var{n}, @var{dim})
-Compute the discrete Fourier transform of @var{A} using
+Compute the discrete Fourier transform of @var{x} using
 a Fast Fourier Transform (FFT) algorithm.
 
 The FFT is calculated along the first non-singleton dimension of the
@@ -202,7 +202,7 @@
 @var{x} is truncated.
 
 If called with three arguments, @var{dim} is an integer specifying the
-dimension of the matrix along which the FFT is performed
+dimension of the matrix along which the FFT is performed.
 @seealso{ifft, fft2, fftn, fftw}
 @end deftypefn */)
 {
@@ -215,7 +215,7 @@
 @deftypefn  {} {} ifft (@var{x})
 @deftypefnx {} {} ifft (@var{x}, @var{n})
 @deftypefnx {} {} ifft (@var{x}, @var{n}, @var{dim})
-Compute the inverse discrete Fourier transform of @var{A}
+Compute the inverse discrete Fourier transform of @var{x}
 using a Fast Fourier Transform (FFT) algorithm.
 
 The inverse FFT is calculated along the first non-singleton dimension
@@ -231,7 +231,7 @@
 then @var{x} is truncated.
 
 If called with three arguments, @var{dim} is an integer specifying the
-dimension of the matrix along which the inverse FFT is performed
+dimension of the matrix along which the inverse FFT is performed.
 @seealso{fft, ifft2, ifftn, fftw}
 @end deftypefn */)
 {
diff -ur a/scripts/audio/lin2mu.m b/scripts/audio/lin2mu.m
--- a/scripts/audio/lin2mu.m
+++ b/scripts/audio/lin2mu.m
@@ -17,7 +17,7 @@
 ## <https://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {} {} lin2mu (@var{x}, @var{n})
+## @deftypefn {} address@hidden =} lin2mu (@var{x}, @var{n})
 ## Convert audio data from linear to mu-law.
 ##
 ## Mu-law values use 8-bit unsigned integers.  Linear values use @var{n}-bit
diff -ur a/scripts/audio/mu2lin.m b/scripts/audio/mu2lin.m
--- a/scripts/audio/mu2lin.m
+++ b/scripts/audio/mu2lin.m
@@ -17,12 +17,12 @@
 ## <https://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {} {} mu2lin (@var{x}, @var{n})
+## @deftypefn {} address@hidden =} mu2lin (@var{x}, @var{n})
 ## Convert audio data from mu-law to linear.
 ##
 ## Mu-law values are 8-bit unsigned integers.  Linear values use @var{n}-bit
-## signed integers or floating point values in the range address@hidden@leq{}1 
if
-## @var{n} is 0.
+## signed integers or floating point values in the range -1 @leq{} @var{y}
+## @leq{} 1 if @var{n} is 0.
 ##
 ## If @var{n} is not specified it defaults to 0.
 ## @seealso{lin2mu}
diff -ur a/scripts/image/ind2gray.m b/scripts/image/ind2gray.m
--- a/scripts/image/ind2gray.m
+++ b/scripts/image/ind2gray.m
@@ -21,7 +21,7 @@
 ## Convert a color indexed image to a grayscale intensity image.
 ##
 ## The image @var{x} must be an indexed image which will be converted using
the
-## colormap @var{cmap}.  If @var{cmap} does not contain enough colors for
the
+## colormap @var{map}.  If @var{map} does not contain enough colors for the
 ## image, pixels in @var{x} outside the range are mapped to the last color
in
 ## the map before conversion to grayscale.
 ##
diff -ur a/scripts/image/rgb2ind.m b/scripts/image/rgb2ind.m
--- a/scripts/image/rgb2ind.m
+++ b/scripts/image/rgb2ind.m
@@ -31,7 +31,7 @@
 ## quantization is performed.  The output class of the indexed image @var{x}
 ## can be uint8, uint16 or double, whichever is required to specify the
 ## number of unique colors in the image (which will be equal to the number
-## of rows in @var{map}) in order
+## of rows in @var{map}) in order.
 ##
 ## Multi-dimensional indexed images (of size @nospell{MxNx3xK}) are also
 ## supported, both via a single input (@var{rgb}) or its three color
channels
diff -ur a/scripts/signal/periodogram.m b/scripts/signal/periodogram.m
--- a/scripts/signal/periodogram.m
+++ b/scripts/signal/periodogram.m
@@ -54,8 +54,8 @@
 ##
 ## @item range
 ## range of spectrum.  @qcode{"@nospell{onesided}"} computes spectrum from
-## [0..nfft/2+1].  @qcode{"@nospell{twosided}"} computes spectrum from
-## [0..nfft-1].
+## [0:nfft/2+1].  @qcode{"@nospell{twosided}"} computes spectrum from
+## [0:nfft-1].
 ## @end table
 ##
 ## The optional second output @var{w} are the normalized angular
frequencies.


Note on mu2lin and lin2mu:
because the variable 'y' appears in the docstring, I add it to the function
definition.

Note on periodogram:
the strange notation [a..b] only appears here in the whole document, so maybe
it is wanted to be replaced with Octave style [a:b] for consistency?




    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?52844>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/