Skip to content

Commit 15f62b4

Browse files
authored
Editorial pass
1 parent 297b2a0 commit 15f62b4

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/interactive-pause.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Interactive Pause
22

3-
It’s hard to write a complete test at once. You will need to try different commands with different arguments before you find a correct path.
3+
It can be difficut to write a successful test on the first attempt. You will need to try different commands, with different arguments, before you find the correct path.
44

5-
Since Codeception 3.0 you can pause execution in any point and enter interactive shell where you will be able to try commands in action.
5+
Since Codeception 3.0, you can pause execution in any point and enter an interactive shell where you will be able to try commands in action.
66

7-
Now this `Interactive Pause` feature is available in MFTF and all you need to do is to set `ENABLE_PAUSE=true` in `.env`.
7+
Now this `Interactive Pause` feature is available in MFTF. All you need to do is to set `ENABLE_PAUSE=true` in `.env`.
88

99
Check [pause on codeception.com][] for documentation and a video to see `Interactive Pause` in action.
1010

11-
In short, when a test gets to `$I->pause()` step, it stops and shows a console where you can try all available commands with auto-completion, stash commands, and save screenshot, etc.
11+
In short, when a test gets to `$I->pause()` step, it stops and shows a console where you can try all available commands with auto-completion, stash commands, save screenshots, etc.
1212

1313
## Generation Time
1414

1515
A `<pause>` action in xml will always be generated into php regardless if `ENABLE_PAUSE=true` is set or not.
1616
However, when `ENABLE_PAUSE=true` is set, an additional`pause()` action will be generated in `_failed()` hook for a test,
17-
so that the test could pause on failure at run time.
17+
so that the test may pause on failure at run time.
1818

1919
## Execution Time
2020

21-
To use `Interactive Pause` at run time, there are two types of MFTF commands to use.
21+
To use `Interactive Pause` at run time, there are two types of MFTF commands to use:
2222

2323
### MFTF Run Commands
2424

@@ -47,17 +47,16 @@ Note: MFTF run command's `--debug` option is different from Codeception `--debug
4747
### MFTF Codecept Run Command
4848

4949
You can also use MFTF's wrapper command to run Codeception directly and activate `Interactive Pause` by passing `--debug` option.
50-
You don't need to set `ENABLE_PAUSE=true` for this command.
50+
You do not need to set `ENABLE_PAUSE=true` for this command.
5151

5252
```bash
5353
vendor/bin/mftf codecept:run --debug
5454
```
5555

5656
<div class="bs-callout-warning">
57-
Note: You may want to limit the usage of this Codeception command with arguments and options for `acceptance` only
58-
since it's what is supported by MFTF. You should also replace `acceptance` to `functional` when using this command when referring to Codeception documentation.
57+
You may want to limit the usage of this Codeception command with arguments and options for `acceptance` only, since it is what is supported by MFTF. You should also change `acceptance` to `functional` when using this command when referring to Codeception documentation.
5958
</div>
6059

6160
## References
6261

63-
[pause on codeception.com](https://codeception.com/docs/02-GettingStarted#Interactive-Pause)
62+
[pause on codeception.com](https://codeception.com/docs/02-GettingStarted#Interactive-Pause)

0 commit comments

Comments
 (0)