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

Typo in the Route53 ListResourceRecordSets API Documentation #2572

Closed
ghost opened this issue Apr 24, 2019 · 1 comment · Fixed by #2617 or #2621
Closed

Typo in the Route53 ListResourceRecordSets API Documentation #2572

ghost opened this issue Apr 24, 2019 · 1 comment · Fixed by #2617 or #2621
Labels
documentation This is a problem with documentation.

Comments

@ghost
Copy link

ghost commented Apr 24, 2019

Please fill out the sections below to help us address your issue.

What issue did you see?

Typo of "TypeThe" in the documentation for Route53 ListResourceRecordSets API

https://github.com/aws/aws-sdk-go/blob/master/service/route53/api.go#L4430

// If you do not specify Name or TypeThe results begin with the first resource
// record set that the hosted zone contains.
//
// If you specify Name but not TypeThe results begin with the first resource
// record set in the list whose name is greater than or equal to Name.
//
// If you specify Type but not NameAmazon Route 53 returns the InvalidInput
// error.
//
// If you specify both Name and TypeThe results begin with the first resource
// record set in the list whose name is greater than or equal to Name, and whose
// type is greater than or equal to Type.
@diehlaws diehlaws self-assigned this Apr 25, 2019
@diehlaws diehlaws added the documentation This is a problem with documentation. label Apr 25, 2019
@diehlaws
Copy link
Contributor

Thanks for reaching out to us @jmtrusona. This stems from the way in which our docs are generated from our source, similar to #2374. I'll bring this up with the rest of the team during our next sprint to further investigate and resolve this behavior.

jasdel added a commit to jasdel/aws-sdk-go that referenced this issue May 23, 2019
Fixes bugs in how the SDK generates the Go documentation for the AWS
API clients.

Fix aws#2572
Partial Fix aws#2374
jasdel added a commit to jasdel/aws-sdk-go that referenced this issue May 23, 2019
Fixes bugs in how the SDK generates the Go documentation for the AWS
API clients.

Fix aws#2572
Partial Fix aws#2374
jasdel added a commit that referenced this issue May 24, 2019
Improves the SDK's generated documentation for API client, operation, and types. This fixes several bugs in the doc generation causing poor formatting, an difficult to read reference documentation.

Fix #2572
Fix #2374
diehlaws pushed a commit to diehlaws/aws-sdk-go that referenced this issue Jul 2, 2019
Improves the SDK's generated documentation for API client, operation, and types. This fixes several bugs in the doc generation causing poor formatting, an difficult to read reference documentation.

Fix aws#2572
Fix aws#2374
@diehlaws diehlaws removed their assignment Aug 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
1 participant