Make the configuration documentation in a table. #2907
+49
−64
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.
So that default is displayed, but on Windows and MacOS, there's a missing default and there are values that dont have a default ?
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.md
has been updated with a migration guide (for breaking changes)configuration.schema.json
updated if new parameters are added.What kind of change does this PR introduce?
Documentation get's a better format.
What is the current behavior?
The defaults are not really available in the doc and it is a bit hard to understand, plus the directories seems to be there twice.
What is the new behavior?
Documentation is now a table with default values, it should be reviewed to add a few defaults (in code) and the value for
buld_cache.path
on Windows an MacOS in this doc.Does this PR introduce a breaking change, and is titled accordingly?
Other information
Sorry, this a pull request replacing #2906 . Which had errors and I fixed bypassed them by creating another pull request after the last changes.