godot-docs icon indicating copy to clipboard operation
godot-docs copied to clipboard

operator documentation "<" and ">" are missing for Vector types.

Open albinaask opened this issue 2 years ago • 1 comments

Your Godot version: 3.x, presumably 4.0

Issue description: The operators less than and equal than is not defined in neither the Vector2 or the Vector3 class docs. This should be documented since it is ambiguous. What this operator compares is in the context of Godot is the euclidean lengths of the vectors compared. However the operator is in other context for example used to compare theta in a circular vector space or to compare the component sum.

URL to the documentation page (if already existing): https://docs.godotengine.org/en/stable/classes/class_vector2.html https://docs.godotengine.org/en/stable/classes/class_vector3.html

albinaask avatar Sep 14 '22 11:09 albinaask

Godot 3.x lacks support for documenting operators (unlike 4.0), so the only place to document their behavior is in the class description.

Calinou avatar Sep 14 '22 17:09 Calinou