Render API doc markdown as native godoc in comments#1719
Draft
tanmay-db wants to merge 1 commit into
Draft
Conversation
Regenerated doc comments with genkit's new docfmt renderer, which parses spec descriptions as CommonMark and emits godoc-native comment syntax instead of word-wrapped raw markdown: - fenced code examples -> tab-indented godoc code blocks (previously collapsed onto a single line inside literal ``` fences) - bullet/numbered lists -> godoc list syntax (previously broken by word-wrap, leaving list markers dangling mid-line) - markdown reference links keep their godoc-native [text]: url form Generated from the exact OpenAPI spec sha the SDK is pinned to (.codegen/_openapi_sha), so the diff is comment-only: every changed line is a // comment line, verified mechanically. The full toolchain (goimports, gofmt, mockery) ran as in the regular pipeline. Co-authored-by: Isaac
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
|
Please ensure that the NEXT_CHANGELOG.md file is updated with any relevant changes. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Regenerated doc comments with genkit's new docfmt renderer, which parses spec descriptions as CommonMark and emits godoc-native comment syntax instead of word-wrapped raw markdown:
Generated from the exact OpenAPI spec sha the SDK is pinned to (.codegen/_openapi_sha), so the diff is comment-only: every changed line is a // comment line, verified mechanically. The full toolchain (goimports, gofmt, mockery) ran as in the regular pipeline.
Co-authored-by: Isaac
Summary
Why
What changed
Interface changes
Behavioral changes
Internal changes
How is this tested?