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

Support shortdocs for cog commands #1387

Open
davejlong opened this issue Apr 14, 2017 · 2 comments
Open

Support shortdocs for cog commands #1387

davejlong opened this issue Apr 14, 2017 · 2 comments

Comments

@davejlong
Copy link
Member

davejlong commented Apr 14, 2017

When outputting the help page for Cog, it would be useful to see a "shortdoc" for cog commands.

For example, on the Twitter bundle, the output of @cog help twitter is:

> **Commands**
>
> * `tweet` - Tweet from one or more accounts

It would be more user friendly if the format included the basic syntax of the command:

> **Commands**
>
> * `tweet` - Tweet from one or more accounts
>    * `twitter:tweet [--as <as>] <message>`
@ohaiwalt
Copy link
Member

ohaiwalt commented Apr 28, 2017

We can do this now by including them in the description field in the bundle config.yml, can't we?

It is unclear that's possible without some fussing though.

@nmohoric
Copy link
Member

Since we already have an examples field we could probably loop through the non-empty lines and add this. Since this is a text field I do worry about existing stuff not being formatted correctly and becoming a mess.

Maybe we make it so the examples field accepts a list as well (at least for now). A text examples field will just throw the whole blob under there (or maybe not show at all), and a list can individually list them out. This would allow us to slowly transition existing stuff.

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

3 participants