[FEATURE REQ] add functionality for getting help for a particular command about grofer HOT 21 CLOSED

Maybe create a new folder src/display/misc or something like that, because we might need a widget/screen for killing a process, so those widgets can be grouped under that package.

from grofer.

@Gituser143 Yeah a table widget is what I'm looking into. I understand the part about pausing the UI, ohpefully wont run into too many issues

from grofer.

Can I pick this up?

from grofer.

Absolutely!

from grofer.

Awesome! Just to be sure, all the commands are listed in the usage section of the readme right? (i.e, no other commands/flags exist)

from grofer.

Yep!
All commands/flags for the latest release are available in the README.

from grofer.

I'm still working on this 😄

from grofer.

I think I should wait on #54, since my changes will be in the same files

from grofer.

Ah okay, cool cool, I'll re-assign you

from grofer.

So what I've been thinking for this is to create a general help widget, which can take a help string and display it as required, as well as handling the necessary keybindings. This can then be used in the 3 subcommands with the appropriate help strings. Do you think this is a good way to go? If so, what would be the best place to define such a widget?

from grofer.

Bump @MadhavJivrajani @Gituser143 @metonymic-smokey

from grofer.

Hi @anihm136,
Apologies for the late response, yes that seems like a good way to go about it, just one question:

which can take a help string and display it as required

I didn't quite get you here, could you give an example about what would count as a "help string"?

from grofer.

@anihm136 Sorry for the delay! This seems perfect in theory. Maybe use a list or table widget to make it work? You could pause the UI rendering and then render just this help widget when the help key is pressed.

If you feel that's doable, you could get started on that!

from grofer.

I didn't quite get you here, could you give an example about what would count as a "help string"?

Something like pressing h for help box. That's what was mentioned in the issue description. Correct me if I'm wrong though @anihm136

from grofer.

That's what I understood from the keybindings part.

from grofer.

@MadhavJivrajani what I mean is simply a newline-separated string, which contains some help message (need not be restricted to keybindings). The widget would handle splitting the string, formatting and displaying it appropriately. This is kind of how it's implemented in gotop, but there the help string is hardcoded into the widget, resulting in help for all the screens being displayed every time. I feel by making it modular we can be more flexible and display exactly the help that is needed for the current screen

from grofer.

Gotcha. That sounds good!

from grofer.

@anihm136 You might want to look into list too, that helps with scrolling!

from grofer.

Will do

from grofer.

@anihm136 You might want to look into list too, that helps with scrolling!

and also providing selection functionality based on what the user chooses while scrolling

from grofer.

What would be the best place to define this widget, considering it's general to all the screens? I was thinking in src/display/general, maybe in a new file?

from grofer.