Document union property key workaround #456
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
This adds to the doc strings for property keys and typed properties a warning about using union types and a description of the workaround. It's essentially the same thing in four places, but it's a big enough deal to warrant being pasted all over. I also added some test cases to make sure it works.
JordonPhillips
force-pushed
the
document-property-key-workaround
branch
from
0336e19 to
9898e14
Compare
nateprewitt
approved these changes
Mar 20, 2025
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 adds to the doc strings for property keys and typed properties a warning about using union types and a description of the workaround. It's essentially the same thing in four places, but it's a big enough deal to warrant being pasted all over.
I also added a test to make sure it works.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.