https://bugs.documentfoundation.org/show_bug.cgi?id=123192
Bug ID: 123192
Summary: Improve help for function ATAN2
Product: LibreOffice
Version: 6.3.0.0.alpha0+ Master
Hardware: x86-64 (AMD64)
OS: Windows (All)
Status: UNCONFIRMED
Severity: enhancement
Priority: medium
Component: Documentation
Assignee: [email protected]
Reporter: [email protected]
CC: [email protected]
The ATAN2 function in Calc has the syntax
ATAN2(NumberX; NumberY)
Unfortunately that is the opposite order of arguments as usual in programming
language, e.g. Python, JavaScript, C++.
So there should be a warning about this fact. It could be something like this,
"Programming languages have usually the opposite order of arguments for their
atan2 function."
In this light, the given example is badly chosen, because both parameters have
the same value 20 in the example. And using a point from the first quadrant,
masks the advantage over using ATAN(NumberY/NumberX).
The example should use a point from the second quadrant, e.g. point(-5|9).
The help says "Returns the inverse trigonometric tangent of the specified x and
y coordinates.". That makes no mathematical sense, remove it. Suggestion:
"ATAN2 returns the angle (in radians) between the x-axis and a line from the
origin to the point (NumberX|NumberY)".
The text "To return the angle in degrees, use the DEGREES function." is
misleading, because it sounds as if DEGREES would be a similar function as
ATAN2, only that the result is in degrees. The example has it correct. It
should be something like this, "To get the angle in degrees apply the DEGREES
function to the result."
The spec has the text, "ATAN2(0;0) is implementation-defined, evaluators may
return 0 or an Error.". The help is missing, what LibreOffice does. In fact,
LibreOffice results 0 for ATAN2(0;0). But Excel 365 results error #DIV/0! for
ATAN2(0;0). Therefore it should be mentioned.
The help should mention, that the function can be used in converting cartesian
coordinates to polar coordinates.
An illustration would be helpful.
--
You are receiving this mail because:
You are the assignee for the bug._______________________________________________
Libreoffice-bugs mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/libreoffice-bugs
