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

Fix deprecated tag in JSDoc comments #942

Merged
merged 1 commit into from
Jan 9, 2020
Merged

Conversation

justinvp
Copy link
Member

@justinvp justinvp commented Jan 8, 2020

The description in the doc comment should come before the @deprecated tag, otherwise the description will be included as part of the deprecation message.

Part of pulumi/docs#2229
Related: pulumi/pulumi-eks#301

@justinvp justinvp requested a review from lblackstone January 8, 2020 22:29
@justinvp justinvp added the impact/no-changelog-required This issue doesn't require a CHANGELOG update label Jan 8, 2020
Copy link
Member

@lblackstone lblackstone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change LGTM, but let's hold off on this until I've released #941

sdk/nodejs/storage/v1beta1/CSINode.ts Outdated Show resolved Hide resolved
@lblackstone
Copy link
Member

@justinvp This will need a rebase now that I've fixed the CSINode thing

The description in the doc comment should come before the `@deprecated` tag, otherwise the description will be included as part of the deprecation message.
@justinvp
Copy link
Member Author

justinvp commented Jan 9, 2020

@lblackstone Rebased

@lblackstone lblackstone merged commit 088bf76 into master Jan 9, 2020
@pulumi-bot pulumi-bot deleted the justin/deprecated branch January 9, 2020 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact/no-changelog-required This issue doesn't require a CHANGELOG update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants