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

@deprecated message and since in JSDoc #1425

Open
kaspar-p opened this issue Oct 2, 2024 · 0 comments
Open

@deprecated message and since in JSDoc #1425

kaspar-p opened this issue Oct 2, 2024 · 0 comments

Comments

@kaspar-p
Copy link

kaspar-p commented Oct 2, 2024

The @deprecated trait goes into the JSDoc of the relevant field, but the message: and since: strings are not put anywhere. Usually deprecation has a "see other usage" or some sort of explanation that is helpful here, and it'd be nice for clients to see that in the documentation of that type/field.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kaspar-p