From 27ee062687864dcd68e3a40adcab7f119bc10c04 Mon Sep 17 00:00:00 2001 From: sanine Date: Fri, 11 Oct 2024 14:32:33 -0500 Subject: fix macro title formatting --- README.md | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4a15c52..d9876a8 100644 --- a/README.md +++ b/README.md @@ -140,65 +140,79 @@ but a require will also immediately stop executing the test in addition. ### check macros -**CHECK(x)** +#### CHECK(x) + Marks the test as failed if x is false and prints stringified x. -**CHECK_EQ(x, y, fmt)** +#### CHECK_EQ(x, y, fmt) + Marks the test as failed if x == y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**CHECK_NEQ(x, y, fmt)** +#### CHECK_NEQ(x, y, fmt) + Marks the test as failed if x != y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**CHECK_LT(x, y, fmt)** +#### CHECK_LT(x, y, fmt) + Marks the test as failed if x < y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**CHECK_LE(x, y, fmt)** +#### CHECK_LE(x, y, fmt) + Marks the test as failed if x <= y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**CHECK_GT(x, y, fmt)** +#### CHECK_GT(x, y, fmt) + Marks the test as failed if x > y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**CHECK_GE(x, y, fmt)** +#### CHECK_GE(x, y, fmt) + Marks the test as failed if x >= y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. ### require macros -**REQUIRE(x)** +#### REQUIRE(x) + Marks the test as failed and immediately ends test execution if x is false and prints stringified x. -**REQUIRE_EQ(x, y, fmt)** +#### REQUIRE_EQ(x, y, fmt) + Marks the test as failed and immediately ends test execution if x == y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**REQUIRE_NEQ(x, y, fmt)** +#### REQUIRE_NEQ(x, y, fmt) + Marks the test as failed and immediately ends test execution if x != y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**REQUIRE_LT(x, y, fmt)** +#### REQUIRE_LT(x, y, fmt) + Marks the test as failed and immediately ends test execution if x < y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**REQUIRE_LE(x, y, fmt)** +#### REQUIRE_LE(x, y, fmt) + Marks the test as failed and immediately ends test execution if x <= y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**REQUIRE_GT(x, y, fmt)** +#### REQUIRE_GT(x, y, fmt) + Marks the test as failed and immediately ends test execution if x > y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -**REQUIRE_GE(x, y, fmt)** +#### REQUIRE_GE(x, y, fmt) + Marks the test as failed and immediately ends test execution if x >= y is false. Prints both the stringified names of x and y as well as their values, using the printf format code provided in fmt. -- cgit v1.2.1