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

[Nicholas Jankowski]

URL:
  <https://savannah.gnu.org/bugs/?60032>

                 Summary: [octave forge] (matgeom) sph2cart2d help text shows
incorrect input order
                 Project: GNU Octave
            Submitted by: nrjank
            Submitted on: Tue 09 Feb 2021 10:11:58 AM EST
                Category: Octave Forge Package
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: Nicholas Jankowski
        Originator Email: 
             Open/Closed: Open
                 Release: other
         Discussion Lock: Any
        Operating System: Any

    _______________________________________________________

Details:

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




    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?60032>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/