More precise documentation of optimizer settings and their defaults #15578
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
cameel
changed the title
cameel
force-pushed
the
more-precise-optimizer-settings-docs
branch
2 times, most recently
from
b166851 to
0eeefd5
Compare
cameel
force-pushed
the
more-precise-optimizer-settings-docs
branch
from
0eeefd5 to
01f1672
Compare
matheusaaguiar
approved these changes
Nov 21, 2024
cameel
force-pushed
the
more-precise-optimizer-settings-docs
branch
from
01f1672 to
8a8b543
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.
When reading these docs I always need a few takes to understand what the defaults actually are and how the settings interact with each other. They're imprecise and confusing. Trying to answer #15576 today it annoyed me enough that I decided to rewrite it, not to have to waste time on decoding them ever again.
Examples:
If "details" is given, "enabled" can be omitted.at first sounds as if includingdetailswas equivalent to turning onenabled. But it actually means thatenabledbecomes redundant because it only provides defaults.The inliner is always off if no details are given,- not true, it is on when the optimizer is enabled.The PR also fixes the docstrings in
OptimiserSettings.hwhich somehow switched places.