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.

Sign up for GitHub

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

Jump to bottom

[options/forms] Provide per-option help text #1961

Closed
frosencrantz opened this issue Jul 16, 2023 · 3 comments
Closed

[options/forms] Provide per-option help text #1961

frosencrantz opened this issue Jul 16, 2023 · 3 comments
Labels
documentation help wanted wishlist

Comments

@frosencrantz
Copy link
Contributor

The develop branch VisiData can now show help at the user input prompt. The input for regex pattern flags have details about what the different flags are.

It would be great if there was per option help when doing input for the options sheet. There are many options that are color, it would be useful if there was color-specific help for those. For values that take date formatting options, it would be helpful if there was help about what the different formats are. This could be used for any similar options.
@saulpw
Copy link
Owner

saulpw commented Jul 17, 2023

That's a great idea, @frosencrantz. Help boxes everywhere!

saulpw added a commit that referenced this issue Oct 27, 2023
@saulpw
[input] smoother input help #2085 #1961
4b061f7 
- inputMultiple help fixed
- only display one help sidebar
- cycle through disp_help with Ctrl+G
saulpw added a commit that referenced this issue Nov 2, 2023
@saulpw
[help] add option help apart from description #1961
f900edc 
- store all help strings like these on vd.help_foo for easy reuse
- added help for formatting
- mark other needed help strings with HELPTODO
@saulpw
Copy link
Owner

saulpw commented Nov 2, 2023 •
edited by anjakefala
Loading

Okay, I added the framework for per-option extra help, with the format strings filled out, and HELPTODO stubs for the rest:

  • visidata/aggregators.py:vd.help_aggrs = 'HELPTODO'
  • visidata/features/join.py: vd.help_join = 'HELPTODO'
  • visidata/color.py:vd.help_color = 'HELPTODO'
  • visidata/path.py:vd.help_encoding = 'HELPTODO'
  • visidata/path.py:vd.help_encoding_errors = 'HELPTODO'
  • visidata/text_source.py:vd.help_regex = 'HELPTODO'

I'd love some 'help' with writing these!

saulpw added a commit that referenced this issue Nov 2, 2023
@saulpw
[help] add option help apart from description #1961
7102422 
- store all help strings like these on vd.help_foo for easy reuse
- added help for formatting
- mark other needed help strings with HELPTODO
saulpw added a commit that referenced this issue Nov 8, 2023
@saulpw
[help] add help_regex #1961
1119ab8
saulpw added a commit that referenced this issue Nov 17, 2023
@saulpw
[options] add help for encoding and errors #1961
bc35fbc
saulpw added a commit that referenced this issue Nov 17, 2023
@saulpw
[options] add basic help for color #1961
a32ab09
@anjakefala anjakefala added the 3.0 label Dec 14, 2023
@anjakefala anjakefala added 3.1 and removed 3.0 labels Jan 1, 2024
@saulpw saulpw removed the 3.0.1 label Jan 7, 2024
@saulpw saulpw mentioned this issue Oct 12, 2024
Open
42 tasks
@saulpw
Copy link
Owner

saulpw commented Oct 12, 2024

vd.help_join part of #2313 now

@saulpw saulpw closed this as completed Oct 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation help wanted wishlist
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@saulpw @frosencrantz @anjakefala