[config json schema] declare default values and examples for in-ide documentation #754
Conversation
This file contains hidden or 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
|
last commit (1888824) also extends the description with the default value so it'll be visible in hover and hints in the keys themselves: |
Schniz
force-pushed
the
schniz/add-self-documenting-configuration
branch
from
1888824 to
fab30c4
Compare
this makes most editors autocomplete the default value when you want to override, acting as an in-ide documentation for the keybindings instead of forcing people to go to the website. the only thing I dislike about it is that it is repeating stuff from tui, and the proof for the fragility of this solution is that the 'help' keybinding didn't work well. maybe we can use ts->go generation, or go->ts codegen to ensure they are always in sync. but that's an issue for a different PR I guess.
Schniz
force-pushed
the
schniz/add-self-documenting-configuration
branch
from
fab30c4 to
5fcea61
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
this makes most editors autocomplete the default value when you want to override,
acting as an in-ide documentation for the keybindings instead of forcing people to
go to the website.
the only thing I dislike about it is that it is repeating stuff from tui,
and the proof for the fragility of this solution is that the
helpkeybindingdidn't work well and fixed in this PR.
maybe we can use ts->go generation, or go->ts codegen to ensure
they are always in sync.
but that's an issue for a different PR I guess.