-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Keep doc-string order for shape or exact props #2994
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just a couple comments and missing a changelog entry.
@plotly/dash-test-components/src/components/ShapeOrExactKeepOrderComponent.js
Outdated
Show resolved
Hide resolved
There is failure in unit test that check for hardcoded values that needs to be updated:
For the first three. just need to copy the new generated content and paste it on: https://github.com/plotly/dash/blob/2ec3f5ccc6b0869f41bf6919994a08f7c24332b6/tests/unit/development/metadata_test.py metadata_conversion can change the order of the docstrings: dash/tests/unit/development/test_metadata_conversions.py Lines 29 to 65 in 49a80bb
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💃 Looks good, thank you.
In developing custom components, parameters defined by
PropTypes.shape
orPropTypes.exact
should ensure that the automatically generateddoc-string
follows the original order in the source code.Closes #2990