Skip to content

Commit 0bb5147

Browse files
committed
Address peer review comments
Signed-off-by: Ivan Santiago Paunovic <[email protected]>
1 parent 8de34a0 commit 0bb5147

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

launch_pytest/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ launch_testing is an standalone testing tool, which lacks many features:
1515
* It's impossible to filter test cases by name and run only some.
1616
* It's impossible to mark a test as skipped or xfail.
1717
* The error reporting of the tool was custom, and the output wasn't as nice as the output
18-
generated by other testing frameworks as unittest and pytest.
18+
generated by other testing frameworks such as unittest and pytest.
1919

2020
launch_pytest is a really simple pytest plugin leveraging pytest fixtures to manage a launch service lifetime easily.
2121

@@ -29,7 +29,7 @@ Run the example by doing:
2929
python3 -m pytest test/launch_pytest/examples/pytest_hello_world.py
3030
```
3131

32-
The `launch_pytest` plugin will launch the nodes found in the `launch_descripture` fixture, run the tests from the `test_read_stdout()` class, shut down the launched nodes, and then run the statements after the `yield` statement in `test_read_stdout()`.
32+
The `launch_pytest` plugin will launch the nodes found in the `launch_description` fixture, run the tests from the `test_read_stdout()` class, shut down the launched nodes, and then run the statements after the `yield` statement in `test_read_stdout()`.
3333

3434
#### launch_pytest fixtures
3535

@@ -45,13 +45,14 @@ def launch_description(hello_world_proc):
4545
])
4646
```
4747

48-
A `@launch_pytest.fixture` function should return a `launch.LaunchDescription` object, or a sequence of objects which first item is a `launch.LaunchDescription`.
48+
A `@launch_pytest.fixture` function should return a `launch.LaunchDescription` object, or a sequence of objects whose first item is a `launch.LaunchDescription`.
4949
This launch description will be used in all tests with a mark `@pytest.mark.launch(fixture=<your_fixture_name>)`, in this case `<your_fixture_name>=launch_description`.
5050

5151
The launch description can include a `ReadyToTest` action to signal to the test framework that it's safe to start the active tests.
5252
If one isn't included, a `ReadyToTest` action will be appended at the end.
5353

54-
launch_pytest fixtures can have `module`, `class` or `function` scope, the default is `function`.
54+
`launch_pytest` fixtures can have `module`, `class` or `function` scope.
55+
The default is `function`.
5556
For example:
5657

5758
```python

0 commit comments

Comments
 (0)