Unify configuration, comment the options in config #197
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
This commit removes the almost a 100% redundant tests (two fields were checked differently) and makes a single example configuration for users.
juanfont
reviewed
Oct 23, 2021
Co-authored-by: Juan Font <[email protected]>
juanfont
previously approved these changes
Oct 24, 2021
… into config-simplification
juanfont
previously approved these changes
Oct 24, 2021
juanfont
approved these changes
Oct 24, 2021
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 PR removes the second configuration file so the users only have one place to look and we only have one place to update.
I have also started to add comments to the configuration file describing the configuration options available, and hopefully that can be the start of using it as the main documentation so we only have to update one thing.
I would appreciate if people would help me a bit by using GitHub Comments "suggestions" to add documentation strings to the options that are missing them (or improve my suggestions).