bugGNU Octave - Bugs: bug #52712, some little problems found in...

 
 

bug #52712: some little problems found in octave.pdf

Submitter:  None
Submitted:  Thu 21 Dec 2017 08:51:45 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
   

Thu 21 Dec 2017 11:46:53 AM UTC, comment #2: 

I fixed the problems you uncovered in this cset (http://hg.savannah.gnu.org/hgweb/octave/rev/f8bbaacefc33).

I chose to use the common syntax for complex numbers of "a+bi" rather than "a+i*b".

Rik <rik5>
Group administrator
Thu 21 Dec 2017 10:10:55 AM UTC, comment #1: 

Chapter 7.3, page 130, before the function "who",
there is an example (in "doc/interpreter/var.txi" line 315)
but to run it will raise a warning
because "who" has no option "-variables".

octave:1> str = "A random string";
octave:2> who -variables
warning: who: unrecognized option '-variables'
Variables in the current scope:

str


I don't know how to update this example in the document.

Anonymous
Thu 21 Dec 2017 08:51:45 AM UTC, original submission:  

1.
Chapter 4, page 48, function complex
It seems that "re + im" should be "re + i*im".

2.
Section 6.1.2, page 105
x is a 1x2 struct array, so the text "2-by-1" should be "1-by-2".

3.
Section 6.1.4, page 110, function setfield
Section 12.2.1, page 224, function warning
Section 18.3, page 519, function qz
There are uppercase "XREF" prefix before the function names in the PDF document only in these three places.  I 'grep' the files and find that only these three places are "xref{XREFfuncname}" but all others are "xref{XREFfuncname,,funcname}".  I'm not very familiar with Texinfo, so I'm not sure whether this is a bug.

Possible solutions:

diff '--color=auto' -ur a/doc/interpreter/container.txi b/doc/interpreter/container.txi
--- a/doc/interpreter/container.txi
+++ b/doc/interpreter/container.txi
@@ -258,7 +258,7 @@
 @end example

 @noindent
-which creates a 2-by-1 structure array with two fields.  Another way
+which creates a 1-by-2 structure array with two fields.  Another way
 to create a structure array is with the @code{struct} function
 (@pxref{Creating Structures}).  As previously, to print the value of
 the structure array, you can type its name:
diff '--color=auto' -ur a/libinterp/corefcn/data.cc b/libinterp/corefcn/data.cc
--- a/libinterp/corefcn/data.cc
+++ b/libinterp/corefcn/data.cc
@@ -3226,7 +3226,7 @@
 @w{@code{@var{x} + 0i}}.

 With 2 real arguments, return the complex result
-@w{@code{@var{re} + @var{im}}}.
+@w{@code{@var{re} + i*@var{im}}}.
 @code{complex} can often be more convenient than expressions such as
 @w{@code{a + i*b}}.
 For example:
diff '--color=auto' -ur a/libinterp/corefcn/error.cc b/libinterp/corefcn/error.cc
--- a/libinterp/corefcn/error.cc
+++ b/libinterp/corefcn/error.cc
@@ -1456,7 +1456,7 @@
 The optional warning identifier @var{id} allows users to enable or disable
 warnings tagged by this identifier.  A message identifier is a string of the
 form @qcode{"NAMESPACE:WARNING-NAME"}.  Octave's own warnings use the
-@qcode{"Octave"} namespace (@pxref{XREFwarning_ids}).  For example:
+@qcode{"Octave"} namespace (@pxref{XREFwarning_ids,,warning_ids}).  For example:

 @example
 @group
diff '--color=auto' -ur a/libinterp/corefcn/qz.cc b/libinterp/corefcn/qz.cc
--- a/libinterp/corefcn/qz.cc
+++ b/libinterp/corefcn/qz.cc
@@ -227,7 +227,7 @@
 @end enumerate

 Note: @code{qz} performs permutation balancing, but not scaling
-(@pxref{XREFbalance}), which may be lead to less accurate results than
+(@pxref{XREFbalance,,balance}), which may be lead to less accurate results than
 @code{eig}.  The order of output arguments was selected for compatibility with
 @sc{matlab}.
 @seealso{eig, balance, lu, chol, hess, qr, qzhess, schur, svd}
diff '--color=auto' -ur a/scripts/miscellaneous/setfield.m b/scripts/miscellaneous/setfield.m
--- a/scripts/miscellaneous/setfield.m
+++ b/scripts/miscellaneous/setfield.m
@@ -46,7 +46,7 @@
 ## the space character.  Using arbitrary strings for field names is
 ## incompatible with @sc{matlab}, and this usage will emit a warning if the
 ## warning ID @code{Octave:language-extension} is enabled.
-## @xref{XREFwarning_ids}.
+## @xref{XREFwarning_ids,,warning_ids}.
 ##
 ## With the second calling form, set a field of a structure array.  The
 ## input @var{sidx} selects an element of the structure array, @var{field}


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
    2017-12-21 rik5 StatusNone Fixed
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code