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

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

Closed
rittneje opened this issue May 10, 2024 · 2 comments · Fixed by #2640
Closed

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

rittneje opened this issue May 10, 2024 · 2 comments · Fixed by #2640
Labels
bug This issue is a bug. documentation This is a problem with documentation. p3 This is a minor priority issue queued This issues is on the AWS team's backlog

Comments

@rittneje
Copy link

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

@rittneje rittneje added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels May 10, 2024
@lucix-aws
Copy link
Contributor

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.

@lucix-aws lucix-aws added bug This issue is a bug. p3 This is a minor priority issue queued This issues is on the AWS team's backlog and removed needs-triage This issue or PR still needs to be triaged. labels May 10, 2024
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. documentation This is a problem with documentation. p3 This is a minor priority issue queued This issues is on the AWS team's backlog
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants