Documentation issues

[stefansundin]

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:

// Example iterating over at most 3 pages of a ListAccounts operation.
pageNum := 0
err := client.ListAccountsPages(params,
    func(page *ListAccountsOutput, lastPage bool) bool {   // <--- "chime." missing here before "ListAccountsOutput"
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

Running this command gives you a list of possible errors: (output)

$ grep -r '^//  .*[*][A-Z]' .

Running these two commands gives you a tally of errors versus proper examples:

$ grep -r '^//  .*[*][A-Z]' . | wc -l
     552
$ grep -r '^//  .*[*][a-z]*[.][A-Z]' . | wc -l
     340

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/

Using an AWS SDKYou don't [...]

Using the AWS CLIUse your [...]

Using REST APIIf you use [...]

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! :)

[stefansundin]

I'd like to add one more thing.. Not all function calls have all the types linked. E.g. Credentials is missing links in NewSharedCredentials and NewStaticCredentials. This is probably a thing all over the place. See https://docs.aws.amazon.com/sdk-for-go/api/aws/credentials/#NewSharedCredentials

[diehlaws]

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.