-
Notifications
You must be signed in to change notification settings - Fork 73
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
Comments
We can do this now by including them in the It is unclear that's possible without some fussing though. |
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. |
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:It would be more user friendly if the format included the basic syntax of the command:
The text was updated successfully, but these errors were encountered: