Fix dev:exec command description (#6803)

* fix: command description should not have line break * fix: command description should not have line break * fix: command description should not have line break --------- Co-authored-by: Sean Roberts <[email protected]>
netlify · Oct 17, 2024 · f8a4ac0 · f8a4ac0
1 parent f833f2d
commit f8a4ac0
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 5 deletions.
diff --git a/docs/commands/dev.md b/docs/commands/dev.md
@@ -37,7 +37,7 @@ netlify dev
 
 | Subcommand | description  |
 |:--------------------------- |:-----|
-| [`dev:exec`](/commands/dev#devexec) | Exec command  |
+| [`dev:exec`](/commands/dev#devexec) | Runs a command within the netlify dev environment. For example, with environment variables from any installed add-ons  |
 
 
 **Examples**
@@ -57,8 +57,7 @@ BROWSER=none netlify dev # disable browser auto opening
 ---
 ## `dev:exec`
 
-Exec command
-Runs a command within the netlify dev environment, e.g. with env variables from any installed addons
+Runs a command within the netlify dev environment. For example, with environment variables from any installed add-ons
 
 **Usage**
 

diff --git a/docs/index.md b/docs/index.md
@@ -59,7 +59,7 @@ Local dev server
 
 | Subcommand | description  |
 |:--------------------------- |:-----|
-| [`dev:exec`](/commands/dev#devexec) | Exec command  |
+| [`dev:exec`](/commands/dev#devexec) | Runs a command within the netlify dev environment. For example, with environment variables from any installed add-ons  |
 
 
 ### [env](/commands/env)

diff --git a/src/commands/dev/dev-exec.ts b/src/commands/dev/dev-exec.ts
@@ -29,7 +29,7 @@ export const createDevExecCommand = (program: BaseCommand) =>
       'dev',
     )
     .description(
-      'Exec command\nRuns a command within the netlify dev environment, e.g. with env variables from any installed addons',
+      'Runs a command within the netlify dev environment. For example, with environment variables from any installed add-ons',
     )
     .allowExcessArguments(true)
     .addExamples(['netlify dev:exec npm run bootstrap'])