bugGNU Octave - Bugs: bug #60032, [octave forge] (matgeom)...

 
 

bug #60032: [octave forge] (matgeom) sph2cart2d help text shows incorrect input order

Submitter:  Nicholas Jankowski <nrjank>
Submitted:  Tue 09 Feb 2021 03:11:58 PM UTC
   
 
Category:  Octave Package Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Nicholas Jankowski Open/Closed:  * Closed
Release:  * other Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Thu 17 Jun 2021 12:55:52 AM UTC, comment #7: 
Juan Pablo Carbajal <juanpi>
Group Member
Thu 17 Jun 2021 12:52:38 AM UTC, comment #6: 

The changes are now in the latest commit of the Octave Forge repository https://sourceforge.net/p/octave/matgeom/ci/885571cd6160f401d693d2442b577f5c1f8a0624/

Juan Pablo Carbajal <juanpi>
Group Member
Thu 03 Jun 2021 11:46:54 PM UTC, comment #5: 

Thanks for reporting back 👍

Kai Torben Ohlhus <siko1056>
Group Member
Thu 03 Jun 2021 01:28:21 PM UTC, comment #4: 

just for completeness:

docs for several related files were patched with:
https://github.com/mattools/matGeom/commit/973fe2f0680638ce226b78dbbfc0a080f4df1bc1

and the github issue has been closed

Nicholas Jankowski <nrjank>
Group Member
Wed 02 Jun 2021 02:54:02 AM UTC, comment #3: 

Thanks for confirming @nrjank 🙂

Closing this report.

Kai Torben Ohlhus <siko1056>
Group Member
Wed 02 Jun 2021 02:51:14 AM UTC, comment #2: 

looks like the error is still there. in addition, noticed the sph2cart2d still says sph2cart2 in the function text.  issue reported to github.  see https://github.com/mattools/matGeom/issues/123

Nicholas Jankowski <nrjank>
Group Member
Wed 02 Jun 2021 01:40:45 AM UTC, comment #1: 

Thanks for the report.

matgeom-1.2.3 has been released.

Is this issue still present?

If yes, it should be reported upstream https://github.com/mattools/matGeom

After the package release, it seems to me that Octave Forge matgeom is an "adapter package" only.

Kai Torben Ohlhus <siko1056>
Group Member
Tue 09 Feb 2021 03:11:58 PM UTC, original submission:  

as per https://octave.discourse.group/t/error-in-sph2cart2d-function-help-in-package-matgeom-octave-6-1/724

help for 2ph2cart2d shows the following input order:


SPH2CART2 Convert spherical coordinates to cartesian coordinates.

   C = SPH2CART2(S)
   C = SPH2CART2(THETA, PHI)       (assume rho = 1)
   C = SPH2CART2(THETA, PHI, RHO)
   [X, Y, Z] = SPH2CART2(THETA, PHI, RHO);

   S = [phi theta rho] (spherical coordinate).
   C = [X Y Z]  (cartesian coordinate)


note the input order difference for the single array input S.

Looking at the code, it appears that the single array is handled expecting the same order as the separate inputs. The help also mentions that there was a change made to the input order:

03/11/2006: change convention for angle: uses order [THETA PHI RHO]

I suspect this was just a missed doc change.

cc'd package maintainer

Nicholas Jankowski <nrjank>
Group Member

 

(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 juanpi (Posted a comment)
  • -email is unavailable- added by siko1056 (Posted a comment)
  • -email is unavailable- added by nrjank (Submitted the item)
  • -email is unavailable- added by nrjank
  •  

    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 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-06-03 siko1056 StatusWont Fix Fixed
    2021-06-02 siko1056 StatusNeed Info Wont Fix
        Open/ClosedOpen Closed
    2021-06-02 siko1056 StatusNone Need Info
    2021-02-09 nrjank Carbon-Copy- Added -email is unavailable-

    Back to the top

    Powered by Savane 3.13-4448.
    Corresponding source code