Godot: Vector2.angle() description is not very clear

[KoBeWi]

Godot version:

3.2.3 rc3

OS/device including version:

Issue description:

The description of Vector2.angle() says:

Returns this vector's angle with respect to the X axis, or (1, 0) vector, in radians.

This basically means that Vector2(1, 0) (aka Vector2.RIGHT) has an angle of 0. The description could say it more explicitly.

[aaronfranke]

What could be more clear about it? It seems perfectly clear to me, I don't think there's any other way to interpret this.

[KoBeWi]

I don't think there's any other way to interpret this.

The problem is that not everyone will know how to interpret what does it mean exactly (I mean the description is not _simple_ enough to immediately tell that Vector2.RIGHT is the 0 angle if you are a newbie).

[menip]

I think the description is very clear, and the functionality falls in line with what you learn in maths. I don't think it's the class documentation's job to teach math, just precisely describe the functionality.

[hoontee]

Saying "Vector2.RIGHT" instead of "the X axis" would definitely make it easier to understand for me:

Returns this vector's angle relative to Vector2.RIGHT, or (1, 0), in radians.

[KoBeWi]

I don't think it's the class documentation's job to teach math, just precisely describe the functionality.

I've seen many complains that the documentation isn't easy to grasp for a beginner. This is an example of that.

[Sslaxx]

Saying "Vector2.RIGHT" instead of "the X axis" would definitely make it easier to understand for me:

Returns this vector's angle relative to Vector2.RIGHT, or (1, 0), in radians.

Or that it refers to both.

[hoontee]

Returns this vector's angle relative to Vector2.RIGHT, or (1, 0), in radians.

Or that it refers to both.

The inclusion of (1, 0) already implies the X axis, I feel.

[Meriipu]

I would be more confused if it said Vector2.RIGHT than if it said X-axis.

I've seen many complains that the documentation isn't easy to grasp for a beginner. This is an example of that.

Even after reading the tutorial(s) about what vectors (in godot) are? https://docs.godotengine.org/en/stable/tutorials/math/vector_math.html
What is the definition of beginner being used here? It might seem be a bit rude, but I do not think it is too reasonable to strive for every function on vectors being usable or making sense to somebody who has never heard of vectors before.