docs: Add missing command description

microsoft · Oct 3, 2024 · 88563cb · 88563cb
1 parent 88d6f2e
commit 88563cb
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/tools/api-markdown-documenter/docs/lint-api-model.md b/tools/api-markdown-documenter/docs/lint-api-model.md
@@ -1,13 +1,14 @@
 `api-markdown-documenter lint-api-model`
 ========================================
 
-describe the command here
+Runs a validation pass over the specified API model, reporting any errors found.
+This includes broken `{@link}` and `{@inheritDoc}` tag references, which can not be evaluated on a package-by-package basis by API-Extractor.
 
 * [`api-markdown-documenter lint-api-model APIMODELDIRECTORY`](#api-markdown-documenter-lint-api-model-apimodeldirectory)
 
 ## `api-markdown-documenter lint-api-model APIMODELDIRECTORY`
 
-describe the command here
+Runs a validation pass over the specified API model, reporting any errors found.
 
 ```
 USAGE
@@ -23,7 +24,9 @@ FLAGS
                                   directory to run the command in.
 
 DESCRIPTION
-  describe the command here
+  Runs a validation pass over the specified API model, reporting any errors found.
+  This includes broken `{@link}` and `{@inheritDoc}` tag references, which can not be evaluated on a package-by-package
+  basis by API-Extractor.
 
 EXAMPLES
   $ api-markdown-documenter lint-api-model

diff --git a/tools/api-markdown-documenter/src/commands/lint-api-model.ts b/tools/api-markdown-documenter/src/commands/lint-api-model.ts
@@ -14,6 +14,9 @@ import { loadModel } from "../LoadModel.js";
 import { silentLogger, type Logger } from "../Logging.js";
 import { DocumentWriter } from "../renderers/index.js";
 
+const commandDescription = `Runs a validation pass over the specified API model, reporting any errors found.
+This includes broken \`{@link}\` and \`{@inheritDoc}\` tag references, which can not be evaluated on a package-by-package basis by API-Extractor.`;
+
 /**
  * `oclif` command for linting an API model.
  *
@@ -29,7 +32,7 @@ export default class LintApiModelCommand extends Command {
 		}),
 	};
 
-	public static override description = "describe the command here";
+	public static override description = commandDescription;
 
 	public static override examples = ["<%= config.bin %> <%= command.id %>"];