-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Support @deprecated jsdoc tag #12759
Comments
Hi, Can i dig into this? |
@Kraken-coder yes please! assigned 🚀 |
Hi, I would like to try to fix this issue, but I see someone else already is assigned. Can I try it out still or should I look for another one? Also, is this still a issue, since its from last year? |
@leticiavna please do! 🙏 |
Hi, since it seems there is no update on this issue, I would like to tackle it. |
Gadzooks!! I just released https://github.com/storybookjs/storybook/releases/tag/v7.0.0-beta.30 containing PR #20154 that references this issue. Upgrade today to the
Closing this issue. Please re-open if you think there's still more to do. |
Olé!! I just released https://github.com/storybookjs/storybook/releases/tag/v7.0.0-rc.9 containing PR #21794 that references this issue. Upgrade today to the
|
Is your feature request related to a problem? Please describe
In my component's props TS interface, I can use JSDoc comments to set the description, and can even use the
@default
tag to describe the default value 💯However, nothing happens when I use the
@deprecated
tag.Describe the solution you'd like
Some ideas:
<tr>
gotrequired
anddeprecated
classesNames e.g.<tr className="required">
&<tr className="deprecated">
so that I can easily apply custom styling to these rows.Describe alternatives you've considered
For now I will simply omit deprecated props manually per story via the meta default export's parameters.
parameters.docs.page.excludeProps = ['my_depricated_prop_name']
Are you able to assist to bring the feature to reality?
Perhaps in the future but not at this time.
Additional context
https://jsdoc.app/tags-deprecated.html
The text was updated successfully, but these errors were encountered: