Expand on usage guide in the README #102
Open
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
MattSturgeon
commented
Jun 11, 2024
Comment on lines
+33
to
43
| -- These are the defaults. | ||
| telescope = true, | ||
| telescope_borders = false, | ||
| indentblankline = true, | ||
| notify = true, | ||
| ts_rainbow = true, | ||
| cmp = true, | ||
| illuminate = true, | ||
| lsp_semantic = true, | ||
| mini_completion = true, | ||
| dapui = true, |
There was a problem hiding this comment.
It'd be great to have some brief descriptions too, e.g:
-- These are the defaults.
telescope = true, -- Enable theming telescope panels
telescope_borders = false, -- Also theme telescope panel borders
indentblankline = true, -- Set colors for indentblanklins's indentation guides
notify = true, -- etc
ts_rainbow = true, -- etcI haven't added any because I have no idea what they should be.
The lua API doesn't need/use a prefix.
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.
Inspired by #63 and looking through the setup/config code, I thought I'd take the opportunity to expand on your docs a little.
Hopefully everything is correct! Let me know if not.