Open
Conversation
jliusan
requested review from
RickWinter,
chlowell,
jhendrixMSFT and
lirenhe
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new test case for documentation generation and formatting features in the TypeSpec Go code generator. The test validates proper handling of documentation comments with various formatting styles including bullet points, numbered lists, bold text, italic text, and combined formatting.
Changes:
- Added new
documentationgrouptest package with generated Go client code - Registered the new test in the compilation script
- Added test cases for text formatting (bold, italic, combined) and list formatting (bullet points, numbered lists)
Reviewed changes
Copilot reviewed 19 out of 20 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/typespec-go/.scripts/tspcompile.js | Registered new 'documentationgroup' test in the compilation configuration |
| packages/typespec-go/test/http-specs/documentationgroup/go.mod | Go module definition with dependencies |
| packages/typespec-go/test/http-specs/documentationgroup/go.sum | Dependency checksums |
| packages/typespec-go/test/http-specs/documentationgroup/LICENSE.txt | Standard MIT license file |
| packages/typespec-go/test/http-specs/documentationgroup/zz_*.go | Generated client, model, constant, and supporting code files |
| packages/typespec-go/test/http-specs/documentationgroup/fake/zz_*.go | Generated fake server implementation for testing |
| packages/typespec-go/test/http-specs/documentationgroup/*_test.go | Test files for documentation lists and text formatting clients |
| packages/typespec-go/test/http-specs/documentationgroup/testdata/_metadata.json | Metadata file for the generated code |
tadelesh
approved these changes
Jan 30, 2026
| // BulletPointsEnum - This tests really long bullet points in enum documentation to see how wrapping and formatting are handled. | ||
| // This should wrap around correctly and maintain proper indentation for each line. | ||
| // - Simple bullet point. This bullet point is going to be very long to test how text wrapping is handled in bullet points | ||
| // within documentation comments. It should properly indent the wrapped lines. |
Member
There was a problem hiding this comment.
Hmm this looks wrong. Should be indented.
jhendrixMSFT
requested changes
Jan 30, 2026
Member
jhendrixMSFT
left a comment
jhendrixMSFT
left a comment
There was a problem hiding this comment.
Looks like there are various formatting issues. We should fix them before committing this test.
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
3 participants
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.
Add documentation test