Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
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 valueHowever, 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