Fixed docs for pretty command

asyncapi · Dec 21, 2024 · 49ff105 · 49ff105
1 parent da64c63
commit 49ff105
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/usage.md b/docs/usage.md
@@ -735,7 +735,7 @@ _See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.12
 
 ## `asyncapi pretty SPEC-FILE`
 
-Format AsyncAPI specification file
+Beautify the AsyncAPI spec file (indentation, styling) in place or output the formatted spec to a new file.
 
 ```
 USAGE

diff --git a/src/commands/pretty.ts b/src/commands/pretty.ts
@@ -7,7 +7,7 @@ import { ValidationError } from '../core/errors/validation-error';
 import { prettyFlags } from '../core/flags/pretty.flags';
 
 export default class Pretty extends Command {
-  static readonly description = 'Format AsyncAPI specification file';
+  static readonly description = 'Beautify the AsyncAPI spec file (indentation, styling) in place or output the formatted spec to a new file.';
 
   static readonly examples = [
     'asyncapi pretty ./asyncapi.yaml',
-Original file line number
+Diff line change
@@ Expand Up @@
     ## `asyncapi pretty SPEC-FILE`
-    Format AsyncAPI specification file
+    Beautify the AsyncAPI spec file (indentation, styling) in place or output the formatted spec to a new file.
     ```
     USAGE
@@ Expand Down @@