New Guides API #2134
Merged
New Guides API #2134
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
saulpw
reviewed
Nov 23, 2023
saulpw
reviewed
Nov 25, 2023
saulpw
reviewed
Nov 26, 2023
saulpw
reviewed
Nov 26, 2023
| [:keys]Backspace[/] to come back to this list of guides | ||
| - [:keystrokes]Up/Down[/] to move the row cursor | ||
| - [:keystrokes]Enter[/] to view a topic | ||
| - [:keystrokes]Backspace[/] to come back to this list of guides |
There was a problem hiding this comment.
I think this (- [:keystrokes]gg[/] to {helpstr}) should be the general pattern for commands.
saulpw
reviewed
Nov 26, 2023
saulpw
reviewed
Nov 26, 2023
saulpw
reviewed
Nov 26, 2023
saulpw
reviewed
Nov 26, 2023
saulpw
reviewed
Nov 26, 2023
saulpw
reviewed
Nov 26, 2023
saulpw
reviewed
Nov 26, 2023
Add rowdef and rowtype. guidename -> name Improve documentation and error messaging. open-guide -> open-guide-index
Mention macros can be set to both keystrokes and longnames. Use pattern of "Use command to imperative" for command text.
saulpw
approved these changes
Nov 26, 2023
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New API
vd.addGuide("guidename", GuideObj(source='''Text for guide'''))vd.getGuide(guidename)-> Returns the instantiated Sheet for the guideAdd
color_h1for colouring markdown annotated headers (#).Added a Macros Guide as a proof-of-concept for the API.
displayer='full'guide.pyto VisiData core, and import appropriatelyDemo of Guide Sheet and new
color_h1.