Skip to content

Commit 5155434

Browse files
[STYLE] Apply changes found in review (- WIP PR #242 -)
Changes in file LICENSE.md: * minor changes to style Changes in file docs/Testing.md: * style changes * related work
1 parent 901ce4e commit 5155434

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

LICENSE.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ Dependencies NOT included.
2424

2525
***
2626

27-
## Included Licenses and additional Acknowledgments included with package
27+
## Excluded Licenses, not included with package
2828

2929
### Third-Party Dependencies
3030

31-
Multicast project testing code is under an MIT license like the Multicast module; However
32-
the project's Testing can use tools which are split between multiple licenses (but not be bundled).
33-
While all of the source code is open-source, using some of the project testing is only possible
34-
in an environment where additional, restrictions apply, due to third party licensing which is
35-
incompatible if it were to be included with the rest of the project.
31+
Multicast project testing code is under an MIT license like the Multicast module; however
32+
the project's Testing can use tools which are split between multiple licenses (but may not be
33+
bundled). While all of the source code is open-source, using some of the project testing is only
34+
possible in an environment where additional restrictions apply, due to third-party licensing which
35+
is incompatible if it were to be included with the rest of the project as a whole.
3636

3737
### Files: `requirements.txt`, `docs/requirements.txt`, `tests/requirements.txt`
3838

@@ -50,6 +50,8 @@ The individual dependencies are owned by their respective copyright holders.
5050
_NO ASSOCIATION._
5151
***
5252

53+
## Included Licenses and additional Acknowledgments included with package
54+
5355
### Files in `tests/`: `profiling.py`, `test_basic.py`, `test_usage.py` and parts of `context.py`
5456

5557
***

docs/Testing.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Details about the Multicast project's own testing.
55
***
66

77
> [!CAUTION]
8-
> Multicast project testing code is under an MIT license like the Multicast module; However
8+
> Multicast project testing code is under an MIT license like the Multicast module; however
99
> the project's Testing can use tools which are split between multiple licenses.
10-
> While all of the source-code is open-source, using some of the project test code is only possible
11-
> in an environment where additional, restrictions apply, due to third party licensing which is
10+
> While all the source-code is open-source, using some of the project test code is only possible
11+
> in an environment where additional restrictions apply, due to third-party licensing which is
1212
> incompatible if it were to be included with the rest of the project.
1313
>
1414
> Certain Continuous Integration/Continuous Deployment (CI/CD) tools may require GNU licensed
@@ -96,7 +96,7 @@ Currently, MATs are comprised of the test categories `bootstrap`, `basic`, `buil
9696
9797
#### The Test Runner
9898

99-
The test runner is an often obscure part of the Multicast project testing process, albeit an
99+
The test runner is an obscure part of the Multicast project testing process, albeit an
100100
important part. In general, a test runner is what it sounds like; the component responsible
101101
for running the various tests during the act of testing.
102102

@@ -174,7 +174,7 @@ gitGraph:
174174

175175
##### Test-Driven Contributors
176176

177-
During the development cycle new features will also need testing, (this is mentioned in detail
177+
During the development cycle new features will also need testing (this is mentioned in detail
178178
by the [Contributing Guidelines](https://github.com/reactive-firewall/multicast/tree/HEAD/.github/CONTRIBUTING.md).
179179
This is where the otherwise undocumented Selective Test Runner [`run_selective.py`](https://github.com/reactive-firewall/multicast/tree/HEAD/tests/run_selective.py),
180180
comes into play. While the test runner is used by much of the project automation to run all kinds
@@ -232,7 +232,7 @@ are present.
232232

233233
> [!IMPORTANT]
234234
> To effectively leverage the source code for performing fuzzing, you must install a licensed
235-
> copy of the hypothesis python module.
235+
> copy of the 'hypothesis' Python module.
236236
237237
There is a separate test group for optional fuzz testing aptly named `fuzzing`. Currently, the
238238
`fuzzing` test group contains only one category named `slow`.
@@ -250,7 +250,7 @@ The Multicast Project includes some hooks for automating future performance test
250250
251251
There is a separate test group intended for future performance testing aptly named `performance`.
252252
Currently, the `performance` test group contains only empty categories named `scalability`,
253-
`multi_sender` and `multi_receiver`.
253+
`multi_sender`, and `multi_receiver`.
254254

255255
| Category | _Intended_ Criteria | _TestSuites_ |
256256
|----------|---------------------|--------------|

0 commit comments

Comments
 (0)