Skip to content

Commit 9578ffd

Browse files
authored
Merge pull request #778 from yahyayozo/master
[Docs] Fix typos in docs files (Thanks for your help, @yahyayozo ! I appreciate it!)
2 parents 23e8edb + 6947818 commit 9578ffd

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Like INT, there are variants for different sizes also.
7575

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

8080
TEST_ASSERT_EQUAL(expected, actual)
8181

docs/UnityConfigurationGuide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ In either case, you've got a couple choices for configuring these options:
3333

3434
Unfortunately, it doesn't usually work well to just #define these things in the test itself.
3535
These defines need to take effect where ever unity.h is included.
36-
This would be test test, the test runner (if you're generating one), and from unity.c when it's compiled.
36+
This would be the test, the test runner (if you're generating one), and from unity.c when it's compiled.
3737

3838
## The Options
3939

docs/UnityHelperScriptsGuide.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,12 @@ UnityTestRunnerGenerator.new.run(testfile, runner_name, options)
9494
```
9595

9696
If you have multiple files to generate in a build script (such as a Rakefile), you might want to instantiate a generator object with your options and call it to generate each runner afterwards.
97-
Like thus:
97+
Like this:
9898

9999
```Ruby
100100
gen = UnityTestRunnerGenerator.new(options)
101101
test_files.each do |f|
102-
gen.run(f, File.basename(f,'.c')+"Runner.c"
102+
gen.run(f, File.basename(f,'.c')+"Runner.c")
103103
end
104104
```
105105

@@ -205,7 +205,7 @@ Few usage examples can be found in `/test/tests/test_unity_parameterized.c` file
205205
You should define `UNITY_SUPPORT_TEST_CASES` macro for tests success compiling,
206206
if you enable current option.
207207

208-
You can see list of supported macros list in the
208+
You can see a list of supported macros in the
209209
[Parameterized tests provided macros](#parameterized-tests-provided-macros)
210210
section that follows.
211211

@@ -299,7 +299,7 @@ Unity provides support for few param tests generators, that can be combined
299299
with each other. You must define test function as usual C function with usual
300300
C arguments, and test generator will pass what you tell as a list of arguments.
301301

302-
Let's show how all of them works on the following test function definitions:
302+
Let's show how all of them work on the following test function definitions:
303303

304304
```C
305305
/* Place your test generators here, usually one generator per one or few lines */
@@ -401,17 +401,17 @@ TEST_CASE(4, 6, 30)
401401
Test matix is an advanced generator. It single call can be converted to zero,
402402
one or few `TEST_CASE` equivalent commands.
403403
404-
That generator will create tests for all cobinations of the provided list. Each argument has to be given as a list of one or more elements in the format `[<parm1>, <param2>, ..., <paramN-1>, <paramN>]`.
404+
That generator will create tests for all combinations of the provided list. Each argument has to be given as a list of one or more elements in the format `[<parm1>, <param2>, ..., <paramN-1>, <paramN>]`.
405405
406-
All parameters supported by the `TEST_CASE` is supported as arguments:
406+
All parameters supported by the `TEST_CASE` are supported as arguments:
407407
- Numbers incl type specifiers e.g. `<1>`, `<1u>`, `<1l>`, `<2.3>`, or `<2.3f>`
408-
- Strings incl string concatianion e.g. `<"string">`, or `<"partial" "string">`
408+
- Strings incl string concatenation e.g. `<"string">`, or `<"partial" "string">`
409409
- Chars e.g. `<'c'>`
410410
- Enums e.g. `<ENUM_NAME>`
411411
- Elements of arrays e.g. `<data[0]>`
412412
413-
Let's use our `test_demoParamFunction` test for checking, what ranges
414-
will be generated for our single `TEST_RANGE` row:
413+
Let's use our `test_demoParamFunction` test for checking what ranges
414+
will be generated for our single `TEST_MATRIX` row:
415415
416416
```C
417417
TEST_MATRIX([3, 4, 7], [10, 8, 2, 1],[30u, 20.0f])
@@ -450,11 +450,11 @@ As we can see:
450450

451451
| Parameter | Format | Count of values |
452452
|---|---|---|
453-
| `a` | `[3, 4, 7]` | 2 |
453+
| `a` | `[3, 4, 7]` | 3 |
454454
| `b` | `[10, 8, 2, 1]` | 4 |
455455
| `c` | `[30u, 20.0f]` | 2 |
456456

457-
We totally have 2 * 4 * 2 = 16 equal test cases, that can be written as following:
457+
We totally have 3 * 4 * 2 = 24 equal test cases, that can be written as following:
458458

459459
```C
460460
TEST_CASE(3, 10, 30u)
@@ -516,7 +516,7 @@ ruby unity_test_summary.rb build/test/ ~/projects/myproject/
516516
Or, if you're more of a Windows sort of person:
517517

518518
```Shell
519-
ruby unity_test_summary.rb build\teat\ C:\projects\myproject\
519+
ruby unity_test_summary.rb build\test\ C:\projects\myproject\
520520
```
521521

522522
When configured correctly, you'll see a final summary, like so:

src/unity.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ int suiteTearDown(int num_failures);
4545
* Test Reset and Verify
4646
*-------------------------------------------------------*/
4747

48-
/* These functions are intended to be called before during tests in order
48+
/* These functions are intended to be called before or during tests in order
4949
* to support complex test loops, etc. Both are NOT built into Unity. Instead
5050
* the test runner generator will create them. resetTest will run teardown and
5151
* setup again, verifying any end-of-test needs between. verifyTest will only

0 commit comments

Comments
 (0)