search

aws / aws-sdk-go-v2

AWS SDK for the Go programming language.
https://aws.github.io/aws-sdk-go-v2/docs/
Apache License 2.0
2.5k stars 602 forks source link

package docs for github.com/aws/aws-sdk-go-v2/aws/signer/v4 are malformed #2639

Closed rittneje closed 1 month ago

rittneje commented 1 month ago

Describe the issue

The package docs for github.com/aws/aws-sdk-go-v2/aws/signer/v4 are jumbled up.

image

As you can see, it has half a sentence, followed by a random code block, which itself contains the first half of another sentence.

My guess is that first sentence is supposed to say "Generally using the signer outside of the SDK should not require any additional code." But some automated tooling is misinterpreting the word "code" to signal a code block.

Links

https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/aws/signer/v4

AWS Go SDK V2 Module Versions Used

No response

lucix-aws commented 1 month ago

It appears to have been copied from its v1 predecessor - we can see what it used to say there. I'm going to tweak the docs here in general, they need some updating.

github-actions[bot] commented 1 month ago

This issue is now closed. Comments on closed issues are hard for our team to see. If you need more assistance, please open a new issue that references this one.