bugGNU Octave - Bugs: bug #49032, some small typo in doc-strings

 
 

bug #49032: some small typo in doc-strings

Submitter:  None
Submitted:  Thu 08 Sep 2016 04:54:55 PM 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.0.3
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 08 Sep 2016 06:00:02 PM UTC, comment #1: 

Thanks for your bug report. The luinc.m doc string has already corrected. I think the text in gradient is correct, but maybe ambiguous. The gradients are done along each dimension, which is why they are called one-dimensional, but the results are the same size as the input matrix.

Mike Miller <mtmiller>
Group Member
Thu 08 Sep 2016 04:54:55 PM UTC, original submission:  


--- /usr/share/octave/4.0.3/m/deprecated/luinc.m
+++ luinc.m
@@ -16,6 +16,7 @@
 ## along with Octave; see the file COPYING.  If not, see
 ## <http://www.gnu.org/licenses/>.

+## -*- texinfo -*-
 ## @deftypefn  {Built-in Function} {[@var{L}, @var{U}, @var{P}, @var{Q}] =} luinc (@var{A}, '0')
 ## @deftypefnx {Built-in Function} {[@var{L}, @var{U}, @var{P}, @var{Q}] =} luinc (@var{A}, @var{droptol})
 ## @deftypefnx {Built-in Function} {[@var{L}, @var{U}, @var{P}, @var{Q}] =} luinc (@var{A}, @var{opts})


and I'm not very sure whether the below change is correct.

--- /usr/share/octave/4.0.3/m/general/gradient.m
+++ gradient.m
@@ -31,7 +31,7 @@
 ## If @var{m} is a matrix the gradient is calculated for each dimension.
 ##
 ## @code{[@var{dx}, @var{dy}] = gradient (@var{m})} calculates the
-## one-dimensional gradient for @var{x} and @var{y} direction if @var{m} is a
+## two-dimensional gradient for @var{x} and @var{y} direction if @var{m} is a
 ## matrix.  Additional return arguments can be use for multi-dimensional
 ## matrices.
 ##


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 mtmiller (Posted a comment)
  •  

    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
    2016-09-08 mtmiller StatusNone Fixed
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-02a9.
    Corresponding source code