fix: improve Go doc formatter #2636
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
lucix-aws
reviewed
May 8, 2024
| "id": "bacf869a-b83a-47b2-9c19-349bb8cfb042", | ||
| "type": "bugfix", | ||
| "collapse": true, | ||
| "description": "GoDoc improvement", |
There was a problem hiding this comment.
Suggested change
| "description": "GoDoc improvement", | |
| "description": "Improve general layout and formatting of Go doc comments that are generated from service API models.", |
lucix-aws
approved these changes
May 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improvements:
related to aws/smithy-go#510
fixes #2597
For changes to files under the
/codegen/aws-modelsfolder, and manual edits to autogenerated code (e.g./service/s3/api.go) please create an Issue instead of a PR for those type of changes.If the PR addresses an existing bug or feature, please reference it here.
To help speed up the process and reduce the time to merge please ensure that
Allow edits by maintainersis checked before submitting your PR. This will allow the project maintainers to make minor adjustments or improvements to the submitted PR, allow us to reduce the roundtrip time for merging your request.