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

Improve formatting of package doc for secretsmanager #2597

Closed
2 tasks done
dolmen opened this issue Apr 4, 2024 · 2 comments · Fixed by aws/smithy-go#510 or #2636
Closed
2 tasks done

Improve formatting of package doc for secretsmanager #2597

dolmen opened this issue Apr 4, 2024 · 2 comments · Fixed by aws/smithy-go#510 or #2636
Assignees
@Madrigal
Labels
bug This issue is a bug. documentation This is a problem with documentation. good-first-issue p3 This is a minor priority issue queued This issues is on the AWS team's backlog

Comments

@dolmen
Copy link

dolmen commented Apr 4, 2024

Acknowledgements

Describe the bug

Package documentation for package github.com/aws/aws-sdk-go-v2/service/secretsmanager is unreadable:

  • bad punctuation (the source shows sentences cut just before dots or commas)
  • no paragaphs
  • no use of godoc links

Sources:

Expected Behavior

Doc designed for human consumption.

Current Behavior

https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/secretsmanager#pkg-overview
Capture d’écran 2024-04-04 à 12 34 16

Reproduction Steps

https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/secretsmanager#pkg-overview

Possible Solution

No response

Additional Information/Context

No response

AWS Go SDK V2 Module Versions Used

v1.28.6

Compiler and Version used

N/A

Operating System and version

N/A
@dolmen dolmen added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Apr 4, 2024
@RanVaknin RanVaknin self-assigned this Apr 4, 2024
@RanVaknin RanVaknin removed the needs-triage This issue or PR still needs to be triaged. label Apr 16, 2024
@RanVaknin
Copy link
Contributor

Hi @dolmen ,

Thanks. I agree this should be better formatted.

Adding to backlog.

Thanks,
Ran~

@RanVaknin RanVaknin added documentation This is a problem with documentation. p3 This is a minor priority issue queued This issues is on the AWS team's backlog labels Apr 16, 2024
@lucix-aws lucix-aws assigned Madrigal and unassigned RanVaknin May 2, 2024
Madrigal pushed a commit to aws/smithy-go that referenced this issue May 8, 2024
fix: improve Go doc formatter
40dcd2a 
Improvements:
- Use Go doc links introduced in Go 1.19
- Separate paragraphs so they are rendered as separate blocks of text

fixes aws/aws-sdk-go-v2#2597
Madrigal pushed a commit to aws/smithy-go that referenced this issue May 8, 2024
fix: improve Go doc formatter
fb3ea81 
Improvements:
- Use Go doc links introduced in Go 1.19
- Separate paragraphs so they are rendered as separate blocks of text

fixes aws/aws-sdk-go-v2#2597
@Madrigal Madrigal mentioned this issue May 8, 2024
Merged
Madrigal pushed a commit that referenced this issue May 8, 2024
fix: improve Go doc formatter
96c9b31 
Improvements:
- Use Go doc links introduced in Go 1.19
- Separate paragraphs so they are rendered as separate blocks of text

related to aws/smithy-go#510
fixes #2597
@Madrigal Madrigal mentioned this issue May 8, 2024
Merged
@github-actions GitHub Actions
Copy link

github-actions bot commented May 8, 2024

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
Assignees

@Madrigal Madrigal

Labels
bug This issue is a bug. documentation This is a problem with documentation. good-first-issue p3 This is a minor priority issue queued This issues is on the AWS team's backlog
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: improve Go doc formatter aws/smithy-go
fix: improve Go doc formatter aws/aws-sdk-go-v2
4 participants
@dolmen @Madrigal @RanVaknin @lucix-aws