Skip to content

Document deprecation in comments for shapes and members #258

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

Merged
merged 4 commits into from
Jan 7, 2021

Conversation

trivikr
Copy link
Contributor

@trivikr trivikr commented Jan 6, 2021

Issue #, if available:
Fixes: aws/aws-sdk-js-v3#1868

Description of changes:
Document deprecation in comments for shapes

Shape: Lambda invokeAsync

without deprecated tag

lambda-invokeAsync-no-deprecated-tag

with deprecated tag

lambda-invokeAsync-deprecated

Shape: Lambda InvokeAsyncCommand

without deprecated tag

lambda-InvokeAsyncCommand-no-deprecated-tag

with deprecated tag

lambda-InvokeAsyncCommand-deprecated

Member: WorkDocs DescribeUsersResponse TotalNumberOfUsers

without deprecated tag

Screen Shot 2021-01-06 at 8 13 31 AM

with deprecated tag

Screen Shot 2021-01-06 at 8 13 58 AM

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@trivikr trivikr changed the title Document deprecation in comments for shapes Document deprecation in comments for shapes and members Jan 6, 2021
@trivikr trivikr requested a review from kstich January 7, 2021 17:13
@trivikr trivikr merged commit 3582007 into smithy-lang:master Jan 7, 2021
@trivikr trivikr deleted the docs-add-deprecated-tag branch January 7, 2021 19:24
srchase pushed a commit to srchase/smithy-typescript that referenced this pull request Mar 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add @deprecated in the TSDoc comments if a Smithy shape or member contains deprecated trait
2 participants