gluegun icon indicating copy to clipboard operation
gluegun copied to clipboard

Add the `description` field in the toolbox doc to describe the function in the help listing

Open luizbp opened this issue 2 years ago • 1 comments

I verified through a test that if you pass the description object when creating a new command, it appears in the help command listing, it would be nice to include this in the documentation!

Example:

module.exports = {
  name: 'teste',
  alias: ['t'],
  description: 'teste', // HERE
  run: async (toolbox: GluegunToolbox) => {
    
  }
}

luizbp avatar Apr 16 '24 20:04 luizbp

Want to do the PR @luizbp ? Good call

jamonholmgren avatar Apr 17 '24 02:04 jamonholmgren