-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Documentation issues #2374
Comments
I'd like to add one more thing.. Not all function calls have all the types linked. E.g. |
Hi @stefansundin, thanks for taking the time to put this together and apologies for the delay in our response. Most of these issues stem from the way in which our docs are generated from our source code, which is something we're aware of and will work toward fixing in the near future. |
Fixes the pagination helper method's doc example to refer to the package of the paginator. Fix aws#2374
Fixes the pagination helper method's doc example to refer to the package of the paginator. Fix aws#2374
There are some issues in the documentation. The major one is similar to what I helped fix in a couple of places a while back in #1224, namely that package names are missing for types in examples. This is not the case everywhere, though, but in most examples.
Example from https://docs.aws.amazon.com/sdk-for-go/api/service/chime/#Chime.ListAccountsPages:
Running this command gives you a list of possible errors: (output)
Running these two commands gives you a tally of errors versus proper examples:
So more than half of the examples are affected.
Other minor things
There is a word salad in the Overview section here: https://docs.aws.amazon.com/sdk-for-go/api/service/chime/
There are double bullet points in the lists on the main page (maybe other pages too?): https://docs.aws.amazon.com/sdk-for-go/api/
Hope that helps! :)
The text was updated successfully, but these errors were encountered: