Skip to content

Commit 67246ee

Browse files
Barthélémy Ledouxflotwig
andauthored
fix: update language of comment to match docs
Co-authored-by: Zach Bloomquist <github@chary.us>
1 parent 59b89f7 commit 67246ee

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

cli/lib/cypress.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,13 @@ const cypressModuleApi = {
7070
},
7171

7272
/**
73-
* This function should not be used in pure JavaScript
74-
* By the type of its argument it allows autocompletion and
75-
* type checking of the configuration given by users.
73+
* provides automatic code completion for configuration in many popular code editors.
74+
* While it's not strictly necessary for Cypress to parse your configuration, we
75+
* recommend wrapping your config object with `defineConfig()`
76+
* @example
77+
* module.exports = defineConfig({
78+
* viewportWith: 400
79+
* })
7680
*
7781
* @see ../types/cypress-npm-api.d.ts
7882
* @param {Cypress.ConfigOptions} config

0 commit comments

Comments
 (0)