removing incorrect doc comment #136
Closed
Conversation
This file contains 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
The comment on the New() function points to non-existent functionality, providing extra AWS Config data.
|
Thanks for creating this PR @scottbrown these documentation are actually code generated. If you're looking to update the code generation for the SDKs. We'd be glad to review the updated PR. If not, I can update the code generation. The SDK's private/model/api/api.go is where these comments are coming from. Run |
jasdel
suggested changes
Mar 1, 2018
|
Thanks for bringing this issue to our attention @scottbrown. I took your change in #141 and expanded the fix to all of the SDK's service clients. Going to close this PR in preference of 141. |
jasdel
added a commit
that referenced
this pull request
Mar 6, 2018
Updates the SDK's service initialization doc template to reflect the v2 SDK's configuration update change from v1. Update of #136
jasdel
added a commit
to jasdel/aws-sdk-go-v2
that referenced
this pull request
Mar 8, 2018
Services --- * Synced the V2 SDK with latests AWS service API definitions. Breaking Changes --- * `private/mode/api`: Refactor service paginator helpers to iterator pattern ([aws#119](aws#119)) * Refactors the generated service client paginators to be an iterator pattern. This pattern improves usability while removing the need for callbacks. * See the linked PR for an example. * `private/model/api`: Removes setter helpers from service API types ([aws#101](aws#101)) * Removes the setter helper methods from service API types. Removing clutter and noise from the API type's signature. * Based on feedback [aws#81][aws#81] * `aws`: Rename CanceledErrorCode to ErrCodeRequestCanceled ([aws#131](aws#131)) * Renames CanceledErrorCode to correct naming scheme. SDK Bugs --- * `internal/awsutil`: Fix DeepEqual to consider string alias type equal to string ([aws#102](aws#102)) * Fixes SDK waiters not detecting the correct condition is met. [aws#92](aws#92) * `aws/external`: Fix EnvConfig misspelled container endpoint path getter ([aws#106](aws#106)) * This caused the type to not satisfy the ContainerCredentialsEndpointPathProvider interface. * Fixes [aws#105](aws#105) * `service/s3/s3crypto`: Fix S3Crypto's handling of TagLen ([aws#107](aws#107)) * Fixes the S3Crypto's handling of TagLen to only be set if present. * V2 Fix for [aws/aws-sdk-go#1742](aws/aws-sdk-go#1742) * `private/model/api`: Update SDK service client initialization documentation ([aws#141](aws#141)) * Updates the SDK's service initialization doc template to reflect the v2 SDK's configuration update change from v1. * Related to [aws#136](aws#136) SDK Enhancements --- * `aws`: Improve pagination unit tests ([aws#97](aws#97)) * V2 port of [aws/aws-sdk-go#1733](aws/aws-sdk-go#1733) * `aws/external`: Add example for shared config and static credential helper ([aws#109](aws#109)) * Adds examples for the config helpers; WithSharedConfigProfile, WithCredentialsValue, WithMFATokenFunc. * `private/model/api`: Add validation to prevent collision of api defintions ([aws#112](aws#112)) * V2 port of [aws/aws-sdk-go#1758](aws/aws-sdk-go#1758) * `aws/ec2metadata`: Add support for AWS_EC2_METADATA_DISABLED env var ([aws#128](aws#128)) * When this environment variable is set. The SDK's EC2 Metadata Client will not attempt to make requests. All requests made with the EC2 Metadata Client will fail. * V2 port of [aws/aws-sdk-go#1799](aws/aws-sdk-go#1799) * Add code of conduct ([aws#138](aws#138)) * Update SDK README dep usage ([aws#140](aws#140))
jasdel
added a commit
to jasdel/aws-sdk-go-v2
that referenced
this pull request
Mar 8, 2018
Services --- * Synced the V2 SDK with latests AWS service API definitions. Breaking Changes --- * `private/mode/api`: Refactor service paginator helpers to iterator pattern (aws#119) * Refactors the generated service client paginators to be an iterator pattern. This pattern improves usability while removing the need for callbacks. * See the linked PR for an example. * `private/model/api`: Removes setter helpers from service API types (aws#101) * Removes the setter helper methods from service API types. Removing clutter and noise from the API type's signature. * Based on feedback aws#81 * `aws`: Rename CanceledErrorCode to ErrCodeRequestCanceled (aws#131) * Renames CanceledErrorCode to correct naming scheme. SDK Bugs --- * `internal/awsutil`: Fix DeepEqual to consider string alias type equal to string (aws#102) * Fixes SDK waiters not detecting the correct condition is met. aws#92 * `aws/external`: Fix EnvConfig misspelled container endpoint path getter (aws#106) * This caused the type to not satisfy the ContainerCredentialsEndpointPathProvider interface. * Fixes aws#105 * `service/s3/s3crypto`: Fix S3Crypto's handling of TagLen (aws#107) * Fixes the S3Crypto's handling of TagLen to only be set if present. * V2 Fix for aws/aws-sdk-go#1742 * `private/model/api`: Update SDK service client initialization documentation (aws#141) * Updates the SDK's service initialization doc template to reflect the v2 SDK's configuration update change from v1. * Related to aws#136 SDK Enhancements --- * `aws`: Improve pagination unit tests (aws#97) * V2 port of aws/aws-sdk-go#1733 * `aws/external`: Add example for shared config and static credential helper (aws#109) * Adds examples for the config helpers; WithSharedConfigProfile, WithCredentialsValue, WithMFATokenFunc. * `private/model/api`: Add validation to prevent collision of api defintions (aws#112) * V2 port of aws/aws-sdk-go#1758 * `aws/ec2metadata`: Add support for AWS_EC2_METADATA_DISABLED env var (aws#128) * When this environment variable is set. The SDK's EC2 Metadata Client will not attempt to make requests. All requests made with the EC2 Metadata Client will fail. * V2 port of aws/aws-sdk-go#1799 * Add code of conduct (aws#138) * Update SDK README dep usage (aws#140)
jasdel
added a commit
to jasdel/aws-sdk-go-v2
that referenced
this pull request
Mar 8, 2018
Services --- * Synced the V2 SDK with latests AWS service API definitions. Breaking Changes --- * `private/mode/api`: Refactor service paginator helpers to iterator pattern (aws#119) * Refactors the generated service client paginators to be an iterator pattern. This pattern improves usability while removing the need for callbacks. * See the linked PR for an example. * `private/model/api`: Removes setter helpers from service API types (aws#101) * Removes the setter helper methods from service API types. Removing clutter and noise from the API type's signature. * Based on feedback aws#81 * `aws`: Rename CanceledErrorCode to ErrCodeRequestCanceled (aws#131) * Renames CanceledErrorCode to correct naming scheme. SDK Bugs --- * `internal/awsutil`: Fix DeepEqual to consider string alias type equal to string (aws#102) * Fixes SDK waiters not detecting the correct condition is met. aws#92 * `aws/external`: Fix EnvConfig misspelled container endpoint path getter (aws#106) * This caused the type to not satisfy the ContainerCredentialsEndpointPathProvider interface. * Fixes aws#105 * `service/s3/s3crypto`: Fix S3Crypto's handling of TagLen (aws#107) * Fixes the S3Crypto's handling of TagLen to only be set if present. * V2 Fix for aws/aws-sdk-go#1742 * `private/model/api`: Update SDK service client initialization documentation (aws#141) * Updates the SDK's service initialization doc template to reflect the v2 SDK's configuration update change from v1. * Related to aws#136 SDK Enhancements --- * `aws`: Improve pagination unit tests (aws#97) * V2 port of aws/aws-sdk-go#1733 * `aws/external`: Add example for shared config and static credential helper (aws#109) * Adds examples for the config helpers; WithSharedConfigProfile, WithCredentialsValue, WithMFATokenFunc. * `private/model/api`: Add validation to prevent collision of api defintions (aws#112) * V2 port of aws/aws-sdk-go#1758 * `aws/ec2metadata`: Add support for AWS_EC2_METADATA_DISABLED env var (aws#128) * When this environment variable is set. The SDK's EC2 Metadata Client will not attempt to make requests. All requests made with the EC2 Metadata Client will fail. * V2 port of aws/aws-sdk-go#1799 * Add code of conduct (aws#138) * Update SDK README dep usage (aws#140)
jasdel
added a commit
that referenced
this pull request
Mar 8, 2018
Services --- * Synced the V2 SDK with latests AWS service API definitions. Breaking Changes --- * `private/mode/api`: Refactor service paginator helpers to iterator pattern (#119) * Refactors the generated service client paginators to be an iterator pattern. This pattern improves usability while removing the need for callbacks. * See the linked PR for an example. * `private/model/api`: Removes setter helpers from service API types (#101) * Removes the setter helper methods from service API types. Removing clutter and noise from the API type's signature. * Based on feedback #81 * `aws`: Rename CanceledErrorCode to ErrCodeRequestCanceled (#131) * Renames CanceledErrorCode to correct naming scheme. SDK Bugs --- * `internal/awsutil`: Fix DeepEqual to consider string alias type equal to string (#102) * Fixes SDK waiters not detecting the correct condition is met. #92 * `aws/external`: Fix EnvConfig misspelled container endpoint path getter (#106) * This caused the type to not satisfy the ContainerCredentialsEndpointPathProvider interface. * Fixes #105 * `service/s3/s3crypto`: Fix S3Crypto's handling of TagLen (#107) * Fixes the S3Crypto's handling of TagLen to only be set if present. * V2 Fix for aws/aws-sdk-go#1742 * `private/model/api`: Update SDK service client initialization documentation (#141) * Updates the SDK's service initialization doc template to reflect the v2 SDK's configuration update change from v1. * Related to #136 SDK Enhancements --- * `aws`: Improve pagination unit tests (#97) * V2 port of aws/aws-sdk-go#1733 * `aws/external`: Add example for shared config and static credential helper (#109) * Adds examples for the config helpers; WithSharedConfigProfile, WithCredentialsValue, WithMFATokenFunc. * `private/model/api`: Add validation to prevent collision of api defintions (#112) * V2 port of aws/aws-sdk-go#1758 * `aws/ec2metadata`: Add support for AWS_EC2_METADATA_DISABLED env var (#128) * When this environment variable is set. The SDK's EC2 Metadata Client will not attempt to make requests. All requests made with the EC2 Metadata Client will fail. * V2 port of aws/aws-sdk-go#1799 * Add code of conduct (#138) * Update SDK README dep usage (#140)
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.
The comment on the New() function points to non-existent functionality, providing extra AWS Config data.
For changes to files under the
/model/folder, and manual edits to autogenerated code (e.g./service/s3/api.go) please create an Issue instead of a PR for those type of changes.If there is an existing bug or feature this PR is answers please reference it here.