Skip to content

Commit 8f5868d

Browse files
authored
Merge pull request #111 from PRosenb/adjust_reference
Expand Reference.md section on configuration overrides for examples
2 parents 1e3f6c4 + 903c70e commit 8f5868d

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

REFERENCE.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,8 @@ platforms:
9090
9191
### Control How Examples Are Compiled
9292
93-
The `compile:` section controls the platforms on which the compilation will be attempted, as well as any external libraries that must be installed and included.
93+
Put a file `.arduino-ci.yml` in each example directory where you require a different configuration than default.
94+
The `compile:` section controls the platforms on which the compilation will be attempted, as well as any external libraries that must be installed and included.
9495

9596
```yaml
9697
compile:
@@ -173,15 +174,15 @@ This test defines one `unittest` (a macro provided by `ArduinoUnitTests.h`), cal
173174

174175
The following assertion functions are available in unit tests.
175176

176-
* `assertEqual(arg1,arg2)`
177-
* `assertNotEqual(arg1,arg2)`
178-
* `assertLess(arg1,arg2)`
179-
* `assertMore(arg1,arg2)`
180-
* `assertLessOrEqual(arg1,arg2)`
181-
* `assertMoreOrEqual(arg1,arg2)`
182-
* `assertTrue(arg)`
183-
* `assertFalse(arg)`
184-
* `assertNull(arg)`
177+
* `assertEqual(expected, actual)`
178+
* `assertNotEqual(expected, actual)`
179+
* `assertLess(expected, actual)`
180+
* `assertMore(expected, actual)`
181+
* `assertLessOrEqual(expected, actual)`
182+
* `assertMoreOrEqual(expected, actual)`
183+
* `assertTrue(actual)`
184+
* `assertFalse(actual)`
185+
* `assertNull(actual)`
185186

186187
These functions will report the result of the test to the console, and the testing will continue if they fail.
187188

0 commit comments

Comments
 (0)