Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(FDS-389):[Docs]: Fix propTypes for Table #380

Merged
merged 2 commits into from Feb 17, 2022

Conversation

rociobaena
Copy link
Contributor

@rociobaena rociobaena commented Feb 16, 2022

Currently, docgen does not have support importing propTypes from external locations.
reactjs/react-docgen#33

There is an external package named https://www.npmjs.com/package/react-docgen-external-proptypes-handler but does not have the full support, the proptype description appears as a custom without a clear reference:
Screen Shot 2022-02-16 at 4 05 05 PM

Since this feature is not ready to be used, the propTypes for the table component has been moved to the owner component:
image

PR Author Checklist

@rociobaena rociobaena self-assigned this Feb 16, 2022
@changeset-bot
Copy link

changeset-bot bot commented Feb 16, 2022

⚠️ No Changeset found

Latest commit: 08a1fd6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Feb 16, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/espressive/cascara/5YZEf6VfdmgmS8LL9UF6keMDQSdi
✅ Preview: https://cascara-git-chore-fds-389-show-proptypes-in-table-espressive1.vercel.app

Copy link
Contributor

@lordpixel lordpixel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rociobaena thanks for solving this, I know the approach doesn't seem very streamlined but at this point it is the only thing we can do given the circumstances.

Good work and investigation skills 💯

Copy link
Member

@odiseo42 odiseo42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks ok, merging to have a new release ver

@odiseo42 odiseo42 merged commit c2190d1 into develop Feb 17, 2022
@odiseo42 odiseo42 deleted the chore/FDS-389-show-proptypes-in-table branch February 17, 2022 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants