smithy-lang / smithy-typescript

Smithy code generators for TypeScript. (in development)
Apache License 2.0
231 stars 86 forks source link

@deprecated `message` and `since` in JSDoc #1425

Open kaspar-p opened 1 month ago

kaspar-p commented 1 month ago

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.