fix: doc improvements

forcedotcom · Feb 14, 2018 · 740c0d7 · 740c0d7
1 parent 9b53ceb
commit 740c0d7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/templates/src/command.js.ejs b/templates/src/command.js.ejs
@@ -9,6 +9,12 @@ class <%- klass %> extends Command {
   }
 }
 
+<%- klass %>.description = `
+Describe the command here
+...
+Extra documentation goes here
+`
+
 <%- klass %>.flags = {
 <%_ if (type === 'single') { _%>
   // add --version flag to show CLI version

diff --git a/templates/src/command.ts.ejs b/templates/src/command.ts.ejs
@@ -29,7 +29,7 @@ hello world from <%- name %>!
     `$ <%- cmd %> --name myname
 hello myname from <%- name %>!
 `,
-    '$ <%- cmd %> file outputs "hello world!" to file',
+    '$ <%- cmd %> ./afile outputs "hello world!" to ./afile',
     '$ <%- cmd %> --force',
     '$ <%- cmd %> --help',
   ]