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.

Sign up for GitHub

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

Jump to bottom

godoc generated docs for service/s3 malformatted #2931

Open
bartgrantham opened this issue Dec 12, 2024 · 0 comments
Open

godoc generated docs for service/s3 malformatted #2931

bartgrantham opened this issue Dec 12, 2024 · 0 comments
Labels
documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged.

Comments

@bartgrantham
Copy link

Describe the issue

The comments for service/s3 are formatted in a way that confuses godoc and results in slightly garbled documentation.

For example, see the codeblock that's created from the indents in service/s3/api_op_GetObject.go: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.GetObject (search for "depends on whether you also have the s3:ListBucket permission")

Links

https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.GetObject

AWS Go SDK V2 Module Versions Used

github.com/aws/aws-sdk-go-v2/service/s3 v1.71.0
@bartgrantham bartgrantham added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bartgrantham