chore(charts): Annotate Victory types for example docs #5315
Conversation
This file contains hidden or 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
redallen
previously approved these changes
Jan 7, 2021
dlabrecq
force-pushed
the
2139-chart-docs
branch
from
598f7e1 to
9ba4ee1
Compare
|
PF4 preview: https://patternfly-react-pr-5315.surge.sh |
redallen
approved these changes
Jan 7, 2021
|
Your changes have been released in:
Thanks for your contribution! 🎉 |
|
Thanks! |
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.
The example docs for react-charts currently show Victory's complex object types. For example, the
ChartAreacomponent showsAnimatePropTypeInterfaceas theanimateprop type. However, the Victory docs show theanimatetype astype: boolean | object.This change adds
@propTypeannotations in order to replace Victory's complex object types, shown in the example docs, with something more readable.Fixes #2139
Before
After
