Skip to content

Commit 2c7629a

Browse files
committed
Documentation Updates
1 parent b8bfb01 commit 2c7629a

File tree

5 files changed

+27
-11
lines changed

5 files changed

+27
-11
lines changed

docs/ThrowTheSwitchCodingStandard.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
Hi. Welcome to the coding standard for ThrowTheSwitch.org. For the most part,
44
we try to follow these standards to unify our contributors' code into a cohesive
55
unit (puns intended). You might find places where these standards aren't
6-
followed. We're not perfect. Please be polite where
7-
you notice these discrepancies and we'll try to be polite when we notice yours.
6+
followed. We're not perfect. Please be polite where you notice these discrepancies
7+
and we'll try to be polite when we notice yours.
8+
89
;)
910

1011

@@ -201,3 +202,6 @@ that happens, we like to indent further to line things up in nice tidy columns.
201202

202203
Egad. Really? We use markdown and we like pdf files because they can be made to
203204
look nice while still being portable. Good enough?
205+
206+
207+
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*

docs/UnityAssertionsReference.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -129,22 +129,22 @@ and double assertions (see immediately following section).
129129

130130
### TEST_ASSERT_EACH_EQUAL_X Variants
131131

132-
Unity provides a collection of assertions for arrays containing a variety of
133-
types which can be compared to a single value as well. These are documented in
134-
the Each Equal section below. these are almost on par with the `_MESSAGE`
132+
Unity provides a collection of assertions for arrays containing a variety of
133+
types which can be compared to a single value as well. These are documented in
134+
the Each Equal section below. these are almost on par with the `_MESSAGE`
135135
variants of Unity's Asserts in that for pretty much any Unity type assertion you
136136
can inject _EACH_EQUAL and run assertions on an entire block of memory.
137137

138138
TEST_ASSERT_EACH_EQUAL_TYPEX( expected, actual, {size/count} )
139139

140140
"Expected" is a single value to compare to.
141141
"Actual" is an array where each element will be compared to the expected value.
142-
"Size/count" is one of two parameters necessary to establish the number of array
142+
"Size/count" is one of two parameters necessary to establish the number of array
143143
elements and perhaps the length of elements within the array.
144144

145145
Notes:
146146
- The `_MESSAGE` variant convention still applies here to Each Equal assertions.
147-
- Assertions for handling Each Equal of floating point values are grouped with
147+
- Assertions for handling Each Equal of floating point values are grouped with
148148
float and double assertions (see immediately following section).
149149

150150

@@ -409,10 +409,10 @@ match. Failure messages specify the array index of the failed comparison.
409409
`expected` are single values and `actual` are arrays. `num_elements` specifies
410410
the number of elements in the arrays to compare.
411411

412-
`_HEX` assertions produce failure messages with expected and actual array
412+
`_HEX` assertions produce failure messages with expected and actual array
413413
contents formatted in hexadecimal.
414414

415-
Assertions fail upon the first element in the compared arrays found not to
415+
Assertions fail upon the first element in the compared arrays found not to
416416
match. Failure messages specify the array index of the failed comparison.
417417

418418
#### `TEST_ASSERT_EACH_EQUAL_INT (expected, actual, num_elements)`
@@ -710,4 +710,7 @@ with zeros.
710710
2. You're going to have to be careful of assertions that perform signed
711711
operations, particularly `TEST_ASSERT_INT_WITHIN`.Such assertions might wrap
712712
your `int` in the wrong place, and you could experience false failures. You can
713-
always back down to a simple `TEST_ASSERT` and do the operations yourself.
713+
always back down to a simple `TEST_ASSERT` and do the operations yourself.
714+
715+
716+
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*

docs/UnityConfigurationGuide.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,4 +392,7 @@ every single test case throughout your entire suite of tests.
392392

393393
The defines and macros in this guide should help you port Unity to just about
394394
any C target we can imagine. If you run into a snag or two, don't be afraid of
395-
asking for help on the forums. We love a good challenge!
395+
asking for help on the forums. We love a good challenge!
396+
397+
398+
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*

docs/UnityGettingStartedGuide.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,3 +186,6 @@ test set for that module. Then, this process is repeated for the next test file.
186186
This flexibility of separating tests into individual executables allows us to
187187
much more thoroughly unit test our system and it keeps all the test code out of
188188
our final release!
189+
190+
191+
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*

docs/UnityHelperScriptsGuide.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,3 +237,6 @@ OVERALL UNITY TEST SUMMARY
237237
```
238238

239239
How convenient is that?
240+
241+
242+
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*

0 commit comments

Comments
 (0)