[Octave-bug-tracker] [bug #48178] atan2 docstring needs more detail

[Mike Miller]

Update of bug #48178 (project octave):

                Severity:              3 - Normal => 2 - Minor              
              Item Group:                    None => Feature Request        
                  Status:                    None => Confirmed              
                 Summary: atan2 documentation is wrong => atan2 docstring
needs more detail

    _______________________________________________________

Follow-up Comment #1:

True, some detail is missing here. Having a definition that depends on `arg`
may be ok, but `arg` also defines itself in terms of `atan2`, so a little
circular and maybe not clear to the beginner.

Some sample wordings from standard libraries might help inspire a way to be
clearer here.

POSIX:

> These functions shall compute the principal value of the arc
> tangent of y/x, using the signs of both arguments to determine
> the quadrant of the return value.

C11:

> The atan2 functions compute the value of the arc tangent of
> y/x, using the signs of both arguments to determine the
> quadrant of the return value.

Cppreference.com:

> Computes the arc tangent of y/x using the signs of arguments
> to determine the correct quadrant.



    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?48178>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/