FuzzyEq documentation is completely wrong and can cause bugs

Issue Description

The documentation for FuzzyEq reads: “Returns true if the other Vector3 falls within the epsilon radius of this Vector3.”

This documentation does not actually reflect its behavior, and even caused someone to report the intended behavior as a bug almost two years ago in Vector3:FuzzyEq (and its alias :isClose) return incorrect results - I would have reported it myself if not for this thread.

In line with its real behavior, the documentation for FuzzyEq should state “Returns true if the X, Y, and Z components of the other Vector3 are within epsilon units of each corresponding component of this Vector3.”

Issue Area: Documentation Content
Page URL: Vector3

5 Likes

Thanks for the report! We’ll follow up when we have an update for you.

2 Likes

Hello @Xan_TheDragon ! Thank you for flagging this issue, the documentation is updated with the correct behavior.