Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › testing › expectApproxEqRelInner Private Function expectApproxEqRelInner Doc Source Private Function std.testing.expectApproxEqRelInner
fn expectApproxEqRelInner (comptime T : type , expected : T , actual : T , tolerance : T ) !void Params T : type expected : T actual : T tolerance : T File testing.zig: 299
299
300
301
302
303
304
305
306
307
308
309
310 fn expectApproxEqRelInner (comptime T : type , expected : T , actual : T , tolerance : T ) !void {
switch (@typeInfo (T )) {
.float => if (!math .approxEqRel (T , expected , actual , tolerance )) {
failPrint ("actual {}, not within relative tolerance {} of expected {}\n" , .{ actual , tolerance , expected });
return error .TestExpectedApproxEqRel ;
},
.comptime_float => @compileError ("Cannot approximately compare two comptime_float values" ),
else => @compileError ("Unable to compare non floating point values" ),
}
}