strip internal API, endpoint and test files from API reference #337
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Generated clients shown in PR: aws/aws-sdk-js-v3#2388 |
trivikr
approved these changes
May 13, 2021
srchase
pushed a commit
to srchase/smithy-typescript
that referenced
this pull request
Mar 17, 2023
…y-lang#337) * mark clients internal configs * docs: strip internal API, endpoint and test files in reference
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
This change annotates the config entries that only required by internal implementation as
@internal. The generated API reference will strip them too. This is to inform the users not to set some values in the clients that could potentially break the SDK.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.