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 library itself.

expect

This function is intended to be used only in tests. When ok is false, returns a test failure error.

testing.expect

pub fn expect(ok: bool) !void

File

lib/std/testing.zig:613

Code

pub fn expect(ok: bool) !void {
    if (!ok) return error.TestUnexpectedResult;
}