box icon indicating copy to clipboard operation
box copied to clipboard

Help output in repl

Open cmaujean opened this issue 8 years ago • 4 comments

While exploring in the repl, I'd like to be able to type 'help' and get a list of box commands. i'd like to be able to type help <command> and get a description and usage on that command. much like the web docs, but in the repl. This should, I think, respect the --omit commandline arg and not show help for unavailable commands.

I will be submitting a patch for this, unless the idea gets totally shot down.

cmaujean avatar Mar 20 '17 01:03 cmaujean

Please do make this patch!

On Sun, Mar 19, 2017 at 6:07 PM Christopher Maujean < [email protected]> wrote:

While exploring in the repl, I'd like to be able to type 'help' and get a list of box commands. i'd like to be able to type help and get a description and usage on that command. much like the web docs, but in the repl. This should, I think, respect the --omit commandline arg and not show help for unavailable commands.

I will be submitting a patch for this, unless the idea gets totally shot down.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/erikh/box/issues/201, or mute the thread https://github.com/notifications/unsubscribe-auth/AABJ659ob_SLEJf4IORW7vk4UBsr4tHaks5rndFjgaJpZM4Mh8yP .

erikh avatar Mar 20 '17 03:03 erikh

One suggestion: do it in the repl parse phase, not at the ruby call level, e.g. More like "quit" and "exit" and not like "from". This means it won't have to conform to string handling rules in ruby, and will be easier to use in general.

On Sun, Mar 19, 2017 at 8:44 PM Erik Hollensbe [email protected] wrote:

Please do make this patch!

On Sun, Mar 19, 2017 at 6:07 PM Christopher Maujean < [email protected]> wrote:

While exploring in the repl, I'd like to be able to type 'help' and get a list of box commands. i'd like to be able to type help and get a description and usage on that command. much like the web docs, but in the repl. This should, I think, respect the --omit commandline arg and not show help for unavailable commands.

I will be submitting a patch for this, unless the idea gets totally shot down.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/erikh/box/issues/201, or mute the thread https://github.com/notifications/unsubscribe-auth/AABJ659ob_SLEJf4IORW7vk4UBsr4tHaks5rndFjgaJpZM4Mh8yP .

erikh avatar Mar 20 '17 03:03 erikh

yeah, I hadn't even considered doing it in the ruby phase. It's just not a thing that could logically go at that low of a level.

cmaujean avatar Mar 20 '17 05:03 cmaujean

partially resolved by #235 and #239

erikh avatar Apr 19 '17 10:04 erikh