Improvement in documentation

[n-gram-hub]

Hello, in a Godot forum, I posted a function where I use the PackedVector2Array find method. The method searches for equal vectors and vectors can contain floats. I supposed this method was safe to use even because PackedVector2Array has no is_equal_approx method. But old users warned me not to use this method because maybe (maybe) the engine uses equals with floats, which can cause unpredictable results.

So I'm here to ask you to specify in every corner of the docs what it is safe to use and what it is not: as a user, I can't say what the implementation of a method is like.

[AThousandShips]

I don't think this is needed, if nothing else is said one should assume equality is used rather than anything else, it says "searches for a value"

[n-gram-hub]

Well, the point coords come from a Godot method that returns the points in a curve. The array I search in comes from Godot that caches all the points of the curves.

[n-gram-hub]

I'm ok with the check, that was a forgetfulness due to haste

[AThousandShips]

Not knowing the discussion you had I'm not sure, but if you showed people this code their issue might have been that you did no check to actually see if find returned -1

[AThousandShips]

Their comments aren't on that it's unsafe in general, it's that you're using a curve with points in it and it's complicated

[AThousandShips]

And they're wrong about how it should use the approximate function, as above you expect it to return for exact values, or that it isn't clear that it uses equality for checking, the assumption it does, or even should, use approximate equality

[AThousandShips]

There is however a pitfall that the documentation of Vector2 misses and that is NaN, which also shows up here for the find function, that should probably be documented

[n-gram-hub]

Thanks

[Calinou]

For reference, this was documented in godotengine/godot#75614.