[doc] Added some code docs

indexzero · Jul 11, 2011 · ad40a95 · ad40a95
1 parent 221c170
commit ad40a95
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/forever/cli.js b/lib/forever/cli.js
@@ -223,6 +223,14 @@ cli.clear = function (key) {
   });
 };
 
+//
+// ### function columns (action, value)
+// #### @action {string} The subaction to execute
+// #### @value {Array} The value to use in the specified `action`.
+// Executes the specified subaction: `add`, `rm`, and `set` which 
+// add, remove, or completely overrides the columns used by `forever list`
+// and `forever.list()`.
+//
 cli.columns = function (action, value) {
   if (!~['add', 'rm', 'set'].indexOf(action)) {
     forever.log.error('Invalid action: ' + ('columns ' + action).yellow);