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.

Sign up for GitHub

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

Jump to bottom

docs: show deprecated prop badge #2568

Merged
merged 1 commit into from
Sep 1, 2023
Merged

docs: show deprecated prop badge #2568

merged 1 commit into from
Sep 1, 2023

Conversation

maxcheremisin
Copy link
Member

@maxcheremisin maxcheremisin commented Aug 29, 2023 •
edited
Loading

@changeset-bot
Copy link

changeset-bot bot commented Aug 29, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 590685d

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 Aug 29, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
forma-36 ✅ Ready (Inspect) Visit Preview Sep 1, 2023 9:20am

Base automatically changed from feat/Autocomplete-isOpen|textOnAfterSelect to main August 30, 2023 11:13
@maxcheremisin maxcheremisin marked this pull request as ready for review August 30, 2023 11:17
@maxcheremisin maxcheremisin requested review from Lelith and a team as code owners August 30, 2023 11:17
@github-actions
Copy link

github-actions bot commented Aug 30, 2023 •
edited
Loading

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
CommonJS 129.48 KB (0%) 2.6 s (0%) 124 ms (+115.67% 🔺) 2.8 s
Module 125.96 KB (0%) 2.6 s (0%) 70 ms (-26.07% 🔽) 2.6 s

cf-remylenoir
cf-remylenoir reviewed Aug 30, 2023
View reviewed changes
packages/f36-docs-utils/src/PropsTable/PropsTable.tsx
Copy link
Collaborator

Choose a reason for hiding this comment

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

This looks great!

The way I understand it, if a prop has the @deprecated decorator without content, the badge won't be shown at all, is that correct?

Copy link
Member Author

Choose a reason for hiding this comment

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

right, currently it works that way. but we can also show the badge with no tooltip if you prefer

Screen.Recording.2023-09-01.at.08.34.35.mov

Copy link
Collaborator

Choose a reason for hiding this comment

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

Unless we set a linting rule to prevent contributors from not adding a deprecation guideline, I'd say so 🙂

Copy link
Member Author

Choose a reason for hiding this comment

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

done

cf-remylenoir
cf-remylenoir approved these changes Sep 1, 2023
View reviewed changes
Copy link
Collaborator

@cf-remylenoir cf-remylenoir left a comment

Choose a reason for hiding this comment

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

Thank you for offering this improvement 👌

@maxcheremisin maxcheremisin merged commit 33ea9d1 into main Sep 1, 2023
3 checks passed
@maxcheremisin maxcheremisin deleted the feat/docs_deprecated branch September 1, 2023 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cf-remylenoir cf-remylenoir cf-remylenoir approved these changes

@Lelith Lelith Lelith approved these changes

@mshaaban0 mshaaban0 Awaiting requested review from mshaaban0 mshaaban0 is a code owner automatically assigned from contentful/team-isotopes

@giotiskl giotiskl Awaiting requested review from giotiskl giotiskl is a code owner automatically assigned from contentful/team-isotopes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@maxcheremisin @Lelith @cf-remylenoir