Skip to content

Commit d89dafa

Browse files
authored
Merge pull request #812 from savashn/table-of-contents
[docs] Add table of contents in Unity Assertions Reference
2 parents 36e9b19 + 3240ac9 commit d89dafa

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/UnityAssertionsReference.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
11
# Unity Assertions Reference
22

3+
## Table of Contents
4+
5+
1. [Background and Overview](#background-and-overview)
6+
1. [Super Condensed Version](#super-condensed-version)
7+
2. [Unity Is Several Things But Mainly It’s Assertions](#unity-is-several-things-but-mainly-its-assertions)
8+
3. [What’s an Assertion?](#whats-an-assertion)
9+
4. [Unity’s Assertions: Helpful Messages _and_ Free Source Code Documentation](#unitys-assertions-helpful-messages-and-free-source-code-documentation)
10+
2. [Assertion Conventions and Configurations](#assertion-conventions-and-configurations)
11+
1. [Naming and Parameter Conventions](#naming-and-parameter-conventions)
12+
2. [TEST_ASSERT_EACH_EQUAL_X Variants](#test_assert_each_equal_x-variants)
13+
3. [Configuration](#configuration)
14+
3. [The Assertions in All Their Blessed Glory](#the-assertions-in-all-their-blessed-glory)
15+
1. [Basic Fail, Pass and Ignore](#basic-fail-pass-and-ignore)
16+
2. [Boolean](#boolean)
17+
3. [Signed and Unsigned Integers (of all sizes)](#signed-and-unsigned-integers-of-all-sizes)
18+
4. [Unsigned Integers (of all sizes) in Hexadecimal](#unsigned-integers-of-all-sizes-in-hexadecimal)
19+
5. [Characters](#characters)
20+
6. [Masked and Bit-level Assertions](#masked-and-bit-level-assertions)
21+
7. [Integer Less Than / Greater Than](#integer-less-than--greater-than)
22+
8. [Integer Ranges (of all sizes)](#integer-ranges-of-all-sizes)
23+
9. [Structs and Strings](#structs-and-strings)
24+
10. [Arrays](#arrays)
25+
11. [Integer Array Ranges (of all sizes)](#integer-array-ranges-of-all-sizes)
26+
12. [Each Equal (Arrays to Single Value)](#each-equal-arrays-to-single-value)
27+
13. [Floating Point (If enabled)](#floating-point-if-enabled)
28+
14. [Double (If enabled)](#double-if-enabled)
29+
4. [Advanced Asserting: Details On Tricky Assertions](#advanced-asserting-details-on-tricky-assertions)
30+
1. [How do the EQUAL assertions work for FLOAT and DOUBLE?](#how-do-the-equal-assertions-work-for-float-and-double)
31+
2. [How do we deal with targets with non-standard int sizes?](#how-do-we-deal-with-targets-with-non-standard-int-sizes)
32+
333
## Background and Overview
434

535
### Super Condensed Version

0 commit comments

Comments
 (0)