Skip to content

Commit

Permalink
Merge pull request #363 from Deltrix/patch-1
Browse files Browse the repository at this point in the history
Changed some text issues (Thanks @delrix)
  • Loading branch information
mvandervoord committed Oct 22, 2018
2 parents e4dfeaa + 01cbce8 commit 7d2bf62
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Running Tests

RUN_TEST(func, linenum)

Each Test is run within the macro `RUN_TEST`. This macro performs necessary setup before the test is called and handles cleanup and result tabulation afterwards.
Each Test is run within the macro `RUN_TEST`. This macro performs necessary setup before the test is called and handles cleanup and result tabulation afterwards.

Ignoring Tests
--------------
Expand Down Expand Up @@ -75,7 +75,7 @@ Another way of calling `TEST_ASSERT_FALSE`
TEST_FAIL()
TEST_FAIL_MESSAGE(message)

This test is automatically marked as a failure. The message is output stating why.
This test is automatically marked as a failure. The message is output stating why.

Numerical Assertions: Integers
------------------------------
Expand All @@ -87,7 +87,7 @@ Numerical Assertions: Integers
TEST_ASSERT_EQUAL_INT64(expected, actual)

Compare two integers for equality and display errors as signed integers. A cast will be performed
to your natural integer size so often this can just be used. When you need to specify the exact size,
to your natural integer size so often this can just be used. When you need to specify the exact size,
like when comparing arrays, you can use a specific version:

TEST_ASSERT_EQUAL_UINT(expected, actual)
Expand All @@ -96,7 +96,7 @@ like when comparing arrays, you can use a specific version:
TEST_ASSERT_EQUAL_UINT32(expected, actual)
TEST_ASSERT_EQUAL_UINT64(expected, actual)

Compare two integers for equality and display errors as unsigned integers. Like INT, there are
Compare two integers for equality and display errors as unsigned integers. Like INT, there are
variants for different sizes also.

TEST_ASSERT_EQUAL_HEX(expected, actual)
Expand All @@ -105,7 +105,7 @@ variants for different sizes also.
TEST_ASSERT_EQUAL_HEX32(expected, actual)
TEST_ASSERT_EQUAL_HEX64(expected, actual)

Compares two integers for equality and display errors as hexadecimal. Like the other integer comparisons,
Compares two integers for equality and display errors as hexadecimal. Like the other integer comparisons,
you can specify the size... here the size will also effect how many nibbles are shown (for example, `HEX16`
will show 4 nibbles).

Expand All @@ -115,7 +115,7 @@ Another way of calling TEST_ASSERT_EQUAL_INT

TEST_ASSERT_INT_WITHIN(delta, expected, actual)

Asserts that the actual value is within plus or minus delta of the expected value. This also comes in
Asserts that the actual value is within plus or minus delta of the expected value. This also comes in
size specific variants.


Expand Down Expand Up @@ -199,12 +199,12 @@ Compare two null-terminate strings. Fail if any character is different or if th

TEST_ASSERT_EQUAL_STRING_LEN_MESSAGE(expected, actual, len, message)

Compare two strings. Fail if any character is different, stop comparing after len characters. Output a custom message on failure.
Compare two strings. Fail if any character is different, stop comparing after len characters. Output a custom message on failure.

Pointer Assertions
------------------

Most pointer operations can be performed by simply using the integer comparisons above. However, a couple of special cases are added for clarity.
Most pointer operations can be performed by simply using the integer comparisons above. However, a couple of special cases are added for clarity.

TEST_ASSERT_NULL(pointer)

Expand Down

0 comments on commit 7d2bf62

Please sign in to comment.