docs: improve the example code for autoLogin (#4019)

codeceptjs · Nov 22, 2023 · 1e5dd80 · 1e5dd80
1 parent 0318bbb
commit 1e5dd80
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/docs/plugins.md b/docs/plugins.md
@@ -65,12 +65,14 @@ If a session expires automatically logs in again.
 ```js
 // inside a test file
 // use login to inject auto-login function
+Feature('Login');
+
 Before(({ login }) => {
    login('user'); // login using user session
 });
 
-// Alternatively log in for one scenario
-Scenario('log me in', ( {I, login} ) => {
+// Alternatively log in for one scenario.
+Scenario('log me in', ( { I, login } ) => {
    login('admin');
    I.see('I am logged in');
 });

diff --git a/lib/plugin/autoLogin.js b/lib/plugin/autoLogin.js
@@ -38,12 +38,14 @@ const defaultConfig = {
  * ```js
  * // inside a test file
  * // use login to inject auto-login function
+ * Feature('Login');
+ *
  * Before(({ login }) => {
  *    login('user'); // login using user session
  * });
  *
- * // Alternatively log in for one scenario
- * Scenario('log me in', ( {I, login} ) => {
+ * // Alternatively log in for one scenario.
+ * Scenario('log me in', ( { I, login } ) => {
  *    login('admin');
  *    I.see('I am logged in');
  * });