Skip to content

Commit 36bc773

Browse files
authored
Merge pull request #40 from firefly-zero/docs/update-angle-diff-comment
docs: Update Angle::difference comment
2 parents 457858a + ec45115 commit 36bc773

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

src/graphics_angle.mbt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,9 @@ test "angle normalized" {
146146
}
147147

148148
///|
149-
/// Returns the difference between the two angles, in the range of `[-PI, +PI]`.
149+
/// Returns the minimum rotation needed to go from the `self` Angle to `to`.
150+
/// Return value is positive for counter-clockwise rotations and negative for
151+
/// clockwise rotations, and will be in the range of `[-PI, +PI]`.
150152
/// When `self` and `to` are opposite,
151153
/// returns `-PI` if `self` is smaller than `to`, or `PI` otherwise.
152154
///
@@ -164,6 +166,7 @@ test "angle diff" {
164166
(Angle::from_deg(0), Angle::from_deg(0), Angle::from_deg(0)),
165167
(Angle::from_deg(0), Angle::from_deg(90), Angle::from_deg(90)),
166168
(Angle::from_deg(45), Angle::from_deg(90), Angle::from_deg(45)),
169+
(Angle::from_deg(45 + 360), Angle::from_deg(90), Angle::from_deg(45)),
167170
(Angle::from_deg(0), Angle::from_deg(180), Angle::from_deg(-180)),
168171
(Angle::from_deg(180), Angle::from_deg(0), Angle::from_deg(180)),
169172
(Angle::from_deg(0), Angle::from_deg(-180), Angle::from_deg(180)),

0 commit comments

Comments
 (0)