Skip to content

Commit 1e5dd80

Browse files
authored
docs: improve the example code for autoLogin (#4019)
1 parent 0318bbb commit 1e5dd80

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/plugins.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,14 @@ If a session expires automatically logs in again.
6565
```js
6666
// inside a test file
6767
// use login to inject auto-login function
68+
Feature('Login');
69+
6870
Before(({ login }) => {
6971
login('user'); // login using user session
7072
});
7173

72-
// Alternatively log in for one scenario
73-
Scenario('log me in', ( {I, login} ) => {
74+
// Alternatively log in for one scenario.
75+
Scenario('log me in', ( { I, login } ) => {
7476
login('admin');
7577
I.see('I am logged in');
7678
});

lib/plugin/autoLogin.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,14 @@ const defaultConfig = {
3838
* ```js
3939
* // inside a test file
4040
* // use login to inject auto-login function
41+
* Feature('Login');
42+
*
4143
* Before(({ login }) => {
4244
* login('user'); // login using user session
4345
* });
4446
*
45-
* // Alternatively log in for one scenario
46-
* Scenario('log me in', ( {I, login} ) => {
47+
* // Alternatively log in for one scenario.
48+
* Scenario('log me in', ( { I, login } ) => {
4749
* login('admin');
4850
* I.see('I am logged in');
4951
* });

0 commit comments

Comments
 (0)