Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
luizbp opened this issue Apr 16, 2024 · 1 comment

Comments

@luizbp
Copy link

luizbp commented Apr 16, 2024

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) => {
    
  }
}
@jamonholmgren
Copy link
Member

Want to do the PR @luizbp ? Good call

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants