std.math: update round doc comment to match the builtin

ziglang · Aug 12, 2024 · b015b97 · b015b97
1 parent cab027f
commit b015b97
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/lib/std/math.zig b/lib/std/math.zig
@@ -1140,7 +1140,8 @@ test ByteAlignedInt {
     try testing.expect(ByteAlignedInt(u129) == u136);
 }
 
-/// Rounds the given floating point number to an integer, away from zero.
+/// Rounds the given floating point number to the nearest integer.
+/// If two integers are equally close, round away from zero.
 /// Uses a dedicated hardware instruction when available.
 /// This is the same as calling the builtin @round
 pub inline fn round(value: anytype) @TypeOf(value) {