bugGNU Octave - Bugs: bug #52844, small patch for Chapter signal,...

 
 

bug #52844: small patch for Chapter signal, image, audio, and OOP

Submitter:  None
Submitted:  Tue 09 Jan 2018 08:45:52 AM UTC
   
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  * Closed Release:  * 4.2.1
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 10 Jan 2018 04:15:00 PM UTC, comment #4: 

Your English is fine.  It was the original author who had small difficulties with the language.

Rik <rik5>
Group administrator
Wed 10 Jan 2018 07:02:31 AM UTC, comment #3: 

Thank you very much maintainer.

ps: I do not speak European language, so my English is not good.

Anonymous
Wed 10 Jan 2018 05:13:18 AM UTC, comment #2: 

I pushed your patches here http://hg.savannah.gnu.org/hgweb/octave/rev/93714122ed59.

I rewrote the section about Contour groups that you had identified because it just wasn't phrased naturally for an English speaker.  I speak French as well and it is pretty clear that the original author of this documentation was a French speaker writing in their non-native language.

Rik <rik5>
Group administrator
Tue 09 Jan 2018 01:14:31 PM UTC, comment #1: 

One more patch for the last chapter:

diff -ur a/doc/interpreter/package.txi b/doc/interpreter/package.txi
--- a/doc/interpreter/package.txi
+++ b/doc/interpreter/package.txi
@@ -154,7 +154,7 @@
 The current installation directory can be retrieved by typing

 @example
-current_installation_directory = pkg prefix
+current_installation_directory = pkg ("prefix")
 @end example

 To function properly the package manager needs to keep some
@@ -416,7 +416,7 @@
 distribution packager.  They follow the same conventions as the
 @code{Depends} keyword.  Note that in general, packaging systems such
 as @code{rpm} or @code{deb} and autoprobe the install dependencies
-from the build dependencies, and therefore the often a
+from the build dependencies, and therefore often a
 @code{BuildRequires} dependency removes the need for a
 @code{SystemRequirements} dependency.



And I'm not sure whether the following patch is right:

diff -ur a/doc/interpreter/plot.txi b/doc/interpreter/plot.txi
--- a/doc/interpreter/plot.txi
+++ b/doc/interpreter/plot.txi
@@ -2230,7 +2230,7 @@
 @cindex contour series

 Contour group objects are created by the @code{contour}, @code{contourf}
-and @code{contour3} functions.  The are equally one of the handles returned
+and @code{contour3} functions.  They are equally one of the handles returned
 by the @code{surfc} and @code{meshc} functions.  The properties of the contour
 group are


Anonymous
Tue 09 Jan 2018 08:45:52 AM UTC, original submission:  


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 {} {@var{y} =} 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 {} {@var{y} =} 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 -1@leq{}y@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?

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by None (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-01-10 rik5 StatusNone Fixed
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-3230.
    Corresponding source code