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(docs): add plugin-eslint-tsdoc #4525

Merged
merged 2 commits into from Mar 14, 2023
Merged

Conversation

MYoung25
Copy link
Contributor

and fix TSDoc tags

Issue

n/a

Description

Standardizes doc comments, allows for better IDE experience and more consistent parsing for doc generation

Testing

yarn eslint src/**/*.ts and yarn build:all

Additional context

Continuation of the work in PRs #4506, #4512, and #4513


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

@MYoung25 MYoung25 requested review from a team as code owners March 14, 2023 16:03
@MYoung25
Copy link
Contributor Author

Note: would appreciate @aws/smithy input on a deprecation message/alternative for SmithyException in shapes.ts:28, its the only outstanding warning message

@syall
Copy link
Contributor

syall commented Mar 14, 2023

Note: would appreciate @aws/smithy input on a deprecation message/alternative for SmithyException in shapes.ts:28, its the only outstanding warning message

I think the deprecated warning is still valid. This shouldn't be directly used regardless, so maybe mark it as @internal.

@MYoung25 MYoung25 merged commit 35f60e3 into aws:main Mar 14, 2023
2 checks passed
@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 29, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants