fix(config): options.darken.sidebars.enabled
#343
Merged
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
tmillr
force-pushed
the
fix-options-darken
branch
from
8d36475 to
0db0915
Compare
tmillr
changed the title
options.darken.floats and options.darken.sidebars.enabledoptions.darken.sidebars.enabled
TODO
Note I didn't add this to the vimdoc changelog, nor the vimdoc deprecations file, but I don't feel like this is necessary since it was never extensively documented (there) when it was changed from |
tmillr
force-pushed
the
fix-options-darken
branch
4 times, most recently
from
9743808 to
7c350eb
Compare
Problem: `options.darken.sidebars.enabled` and
`options.darken.sidebars.enable` both exist, but it is only one
option. The default in `config.lua` is `enable`, but it is
referred to as `enabled` as well (both in code and docs). It
used to be `enable` but was renamed to `enabled`, so it is
technically supposed to be `options.darken.sidebars.enabled` at
this time (as of this commit's parent).
Solution: Deprecate and revert `options.darken.sidebars.enabled` back to
`options.darken.sidebars.enable`. This brings it back in-line
with the changelog and runtime deprecation checks. `enable` is
also more consistent as this is what is used in other parts
of the config (e.g. config for `modules`).
Problem: In a couple of places, `options.darken.sidebars` is checked for
truthiness. This seems to be a typo of
`options.darken.sidebars.enable` which is a boolean (unlike the
former, which is a table by default and also documented as a
table). Tables are always truthy.
Solution: Use `options.darken.sidebars.enable` instead of
`options.darken.sidebars` in conditionals.
Reverts: fff3e20
Reverts: 806903c
Fixes: projekt0n#306
tmillr
force-pushed
the
fix-options-darken
branch
from
7c350eb to
4ffdd18
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.
Problem:
options.darken.sidebars.enabledandoptions.darken.sidebars.enableboth exist, but it is only one option. The default inconfig.luaisenable, but it is referred to asenabledas well (both in code and docs). It used to beenablebut was renamed toenabled, so it is technically supposed to beoptions.darken.sidebars.enabledat this time (as of this commit's parent).Solution: Deprecate and revert
options.darken.sidebars.enabledback tooptions.darken.sidebars.enable. This brings it back in-line with the changelog and runtime deprecation checks.enableis also more consistent as this is what is used in other parts of the config (e.g. config formodules).Problem: In a couple of places,
options.darken.sidebarsis checked for truthiness. This seems to be a typo ofoptions.darken.sidebars.enablewhich is a boolean (unlike the former, which is a table by default and also documented as a table). Tables are always truthy.Solution: Use
options.darken.sidebars.enableinstead ofoptions.darken.sidebarsin conditionals.Reverts: fff3e20, 806903c
Fixes: #306