bugGNU Octave - Bugs: bug #54283, Object sizes documentation :...

 
 

bug #54283: Object sizes documentation : [rows, cols, …, dim_N_sz] = size (…)

Submitter:  None
Submitted:  Tue 10 Jul 2018 08:25:30 PM UTC
   
 
Category:  Documentation Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Pierre Labrèche Originator Email:  -email is unavailable-
Open/Closed:  * Closed Release:  * 4.2.0
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 11 Jul 2018 04:00:10 AM UTC, comment #3: 

Fixed the second two typos here: http://hg.savannah.gnu.org/hgweb/octave/rev/32ddc111ff49.

These will also be in the 4.4.1 release.

Rik <rik5>
Group administrator
Wed 11 Jul 2018 12:56:55 AM UTC, comment #2: 

I hit two small typos in the docstring of "size" and another place.  Here is the patch. (They are too small so I didn't open a new bug report.)

diff -u a/libinterp/corefcn/data.cc b/libinterp/corefcn/data.cc
--- a/libinterp/corefcn/data.cc
+++ b/libinterp/corefcn/data.cc
@@ -2624,7 +2624,7 @@
 with multiple output arguments, @code{size} returns the size of dimension N
 in the Nth argument.  The number of rows, dimension 1, is returned in the
 first argument, the number of columns, dimension 2, is returned in the
-second argument, etc.  If there are more dimensions in @var{a} then there are
+second argument, etc.  If there are more dimensions in @var{a} than there are
 output arguments, @code{size} returns the total number of elements in the
 remaining dimensions in the final output argument.

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

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


Anonymous
Tue 10 Jul 2018 09:02:22 PM UTC, comment #1: 

Version 4.2 of Octave is deprecated and no longer supported.  If you can, you should update to the latest stable release (4.4.0).  The first documentation issue you noticed has already been fixed there.  I fixed the second one on the stable branch which will become the bug fix release 4.4.1 shortly.  See http://hg.savannah.gnu.org/hgweb/octave/rev/0e09d5fd7dab.

Marking as fixed and closing report.

Rik <rik5>
Group administrator
Tue 10 Jul 2018 08:25:30 PM UTC, original submission:  

https://octave.org/doc/v4.2.0/Object-Sizes.html
3.3 Object Sizes
[...
: sz = size (a): dim_sz = size (a, dim): [rows, cols, …, dim_N_sz] = size (…)
# Example 4: number of output arguments  is less than the number of dimensions

Two issues :

1) missing parenthesis in "[nr, remainder] = size (ones (2, 3, 4, 5))"

2) The text "Example 4: number of output arguments != number of dimensions"  should read "Example 4: number of output arguments <  number of dimensions"

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-07-10 rik5 StatusNone Fixed
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-4448.
    Corresponding source code