Skip to content

Commit 0f92ba5

Browse files
committed
Using a doc comment instead of a @deprecated tag
1 parent dad6c95 commit 0f92ba5

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

packages/e2e-tests/test/test-shell.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,11 @@ export class TestShell {
4949

5050
/**
5151
* Starts a test shell.
52-
* @private Use the {@link Mocha.Context.startTestShell} hook instead
52+
*
53+
* Beware that the caller is responsible for calling {@link TestShell.kill} (and potentially {@link TestShell.waitForExit}).
54+
*
55+
* Consider calling the `startTestShell` function on a {@link Mocha.Context} instead, as that manages the lifetime the shell
56+
* and ensures it gets killed eventually.
5357
*/
5458
static start(options: TestShellOptions = { args: [] }): TestShell {
5559
let shellProcess: ChildProcessWithoutNullStreams;

0 commit comments

Comments
 (0)