- 
                Notifications
    You must be signed in to change notification settings 
- Fork 136
Closed
Description
This proposal includes 3 changes:
- 
Add documentation API to command classes. For example, if we want to have pry-style APIs: module ExtendCommand class Debug < Nop description "Load `debug` gem and starts a debugging session" banner <<~MSG Usage: debug This command loads the `debug` gem and start a debugging session at the current location. .... MSG end end 
- 
Rename the current helpcommand (showing API documents) to something else, likedoc- In pry,byebuganddebug, thehelpcommand are all used for showing command documents. So I think it's better to align with them.
 
- In 
- 
Support the new helpcommand to list command documents:- help- list all available commands- If we follow what pryorbyebugdo, we only display commands' descriptions.
- If we follow debug, we'll display full documentation for all commands. So in this case we won't need thedescriptionattribute.
- Question: this means we'll be loading command classes by default. Is this a good reason to do that?
 
- If we follow what 
- help <cmd>- display individual commands' full usage (banner).
 
Since this will be a breaking change (renaming a command), we'll need to bump the version that includes this feature to 2.0.
Metadata
Metadata
Assignees
Labels
No labels