The Wayback Machine - https://web.archive.org/web/20201129110328/https://github.com/storybookjs/storybook/issues/12759
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

Support @deprecated jsdoc tag #12759

Open
StJohn3D opened this issue Oct 14, 2020 · 2 comments
Open

Support @deprecated jsdoc tag #12759

StJohn3D opened this issue Oct 14, 2020 · 2 comments

Comments

@StJohn3D
Copy link

@StJohn3D StJohn3D commented Oct 14, 2020

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:

  • It would be nice if the parent <tr> got required and deprecated classesNames e.g. <tr className="required"> & <tr className="deprecated"> so that I can easily apply custom styling to these rows.
  • For deprecated props, it would be nice if the prop name appeared grayed out, and the word Deprecated appeared in bold below it, followed by any description. e.g.

    PropName
    Deprecated since version 2.0

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

@kraken-coder
Copy link

@kraken-coder kraken-coder commented Oct 15, 2020

Hi, Can i dig into this?

@shilman
Copy link
Member

@shilman shilman commented Oct 16, 2020

@kraken-coder yes please! assigned 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.