Add comments in user config struct #3040
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
jesseduffield
force-pushed
the
more-comments-in-config
branch
from
9a13b9a to
27be735
Compare
| @@ -20,7 +20,8 @@ linters: | |||
| linters-settings: | |||
| exhaustive: | |||
| default-signifies-exhaustive: true | |||
|
|
|||
| staticcheck: | |||
| checks: ["all", "-SA1019"] | |||
We're going to make this user config struct a more authoritative source of truth. Some of these fields weren't actually explained anywhere so I've added explanations. In places where a lot of explanation is required I've linked to existing explanations in other docs.
This is pretty funny: the staticcheck linter gets mad if we use a field which is marked in a comment as being deprecated. But it tripped on my own comment saying that a field is deprecated in terms of the user config! Obviously we have to make use of this field, otherwise we would just remove it entirely rather than mark it as deprecated, so I'm silencing this lint. I doubt this lint would actually come in handy in other cases (like when using a third party package) and worst case scenario we just end up fixing the problem when we try to upgrade the package and the deprecated field is now gone).
jesseduffield
force-pushed
the
more-comments-in-config
branch
from
27be735 to
3e2ef84
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.
We're going to make this user config struct a more authoritative source of truth.
Some of these fields weren't actually explained anywhere so I've added explanations.
In places where a lot of explanation is required I've linked to existing explanations in other docs.
PR Description
Please check if the PR fulfills these requirements
go run scripts/cheatsheet/main.go generate)docs/Config.md) have been updated if necessary