Workaround Even Better TOML crash related to allOf
#15992
Merged
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.
Summary
Fixes #15978
Even Better TOML doesn't support
allOf
well. In fact, it just crashes.This PR works around this limitation by avoid using
allOf
in the automaticallyderived schema for the docstring formatting setting.
Alternatives
schemars introduces
allOf
whenver it sees a$ref
alongside other object propertiesbecause this is no longer valid according to Draft 7. We could replace the
visitor performing the rewrite but I prefer not to because replacing
allOf
withoneOf
is only valid for objects that don't have any other
oneOf
oranyOf
schema.Test Plan
Screen.Recording.2025-02-06.at.13.01.50.mov