style: update comments after flotwig

cypress-io · Oct 4, 2021 · 2279c3f · 2279c3f
1 parent fd163a9
commit 2279c3f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/cli/lib/cypress.js b/cli/lib/cypress.js
@@ -70,7 +70,7 @@ const cypressModuleApi = {
   },
 
   /**
-   * provides automatic code completion for configuration in many popular code editors.
+   * Provides automatic code completion for configuration in many popular code editors.
    * While it's not strictly necessary for Cypress to parse your configuration, we
    * recommend wrapping your config object with `defineConfig()`
    * @example

diff --git a/cli/types/cypress-npm-api.d.ts b/cli/types/cypress-npm-api.d.ts
@@ -379,7 +379,17 @@ declare module 'cypress' {
     cli: CypressCommandLine.CypressCliParser
 
     /**
-     * Type helper to make writing `cypress.config.js` easier
+     * Provides automatic code completion for configuration in many popular code editors.
+     * While it's not strictly necessary for Cypress to parse your configuration, we
+     * recommend wrapping your config object with `defineConfig()`
+     * @example
+     * module.exports = defineConfig({
+     *   viewportWith: 400
+     * })
+     *
+     * @see ../types/cypress-npm-api.d.ts
+     * @param {Cypress.ConfigOptions} config
+     * @returns {Cypress.ConfigOptions} the configuration passed in parameter
      */
     defineConfig(config: Cypress.ConfigOptions): Cypress.ConfigOptions
   }