docs(core): add more to repair's command-object describe (#18602)

Co-authored-by: Isaac Mann <isaacplmann@gmail.com> Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
nrwl · Sep 7, 2023 · b8bc460 · b8bc460 · vercel · Sep 7, 2023
1 parent 2cc40a1
commit b8bc460
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 3 deletions.
diff --git a/docs/generated/cli/repair.md b/docs/generated/cli/repair.md
@@ -1,12 +1,29 @@
 ---
 title: 'repair - CLI command'
-description: 'Repair any configuration that is no longer supported by Nx.'
+description: 'Repair any configuration that is no longer supported by Nx.
+
+  Specifically, this will run every migration within the `nx` package
+  against the current repository. Doing so should fix any configuration
+  details left behind if the repository was previously updated to a new
+  Nx version without using `nx migrate`.
+
+  If your repository has only ever updated to newer versions of Nx with
+  `nx migrate`, running `nx repair` should do nothing.
+  '
 ---
 
 # repair
 
 Repair any configuration that is no longer supported by Nx.
 
+    Specifically, this will run every migration within the `nx` package
+    against the current repository. Doing so should fix any configuration
+    details left behind if the repository was previously updated to a new
+    Nx version without using `nx migrate`.
+
+    If your repository has only ever updated to newer versions of Nx with
+    `nx migrate`, running `nx repair` should do nothing.
+
 ## Usage
 
 ```shell

diff --git a/docs/generated/packages/nx/documents/repair.md b/docs/generated/packages/nx/documents/repair.md
@@ -1,12 +1,29 @@
 ---
 title: 'repair - CLI command'
-description: 'Repair any configuration that is no longer supported by Nx.'
+description: 'Repair any configuration that is no longer supported by Nx.
+
+  Specifically, this will run every migration within the `nx` package
+  against the current repository. Doing so should fix any configuration
+  details left behind if the repository was previously updated to a new
+  Nx version without using `nx migrate`.
+
+  If your repository has only ever updated to newer versions of Nx with
+  `nx migrate`, running `nx repair` should do nothing.
+  '
 ---
 
 # repair
 
 Repair any configuration that is no longer supported by Nx.
 
+    Specifically, this will run every migration within the `nx` package
+    against the current repository. Doing so should fix any configuration
+    details left behind if the repository was previously updated to a new
+    Nx version without using `nx migrate`.
+
+    If your repository has only ever updated to newer versions of Nx with
+    `nx migrate`, running `nx repair` should do nothing.
+
 ## Usage
 
 ```shell

diff --git a/packages/nx/src/command-line/repair/command-object.ts b/packages/nx/src/command-line/repair/command-object.ts
@@ -3,7 +3,16 @@ import { linkToNxDevAndExamples } from '../yargs-utils/documentation';
 
 export const yargsRepairCommand: CommandModule = {
   command: 'repair',
-  describe: 'Repair any configuration that is no longer supported by Nx.',
+  describe: `Repair any configuration that is no longer supported by Nx.
+
+    Specifically, this will run every migration within the \`nx\` package
+    against the current repository. Doing so should fix any configuration
+    details left behind if the repository was previously updated to a new
+    Nx version without using \`nx migrate\`.
+
+    If your repository has only ever updated to newer versions of Nx with
+    \`nx migrate\`, running \`nx repair\` should do nothing.
+  `,
   builder: (yargs) =>
     linkToNxDevAndExamples(yargs, 'repair').option('verbose', {
       type: 'boolean',