Conversation
jliusan
requested review from
RickWinter,
chlowell,
jhendrixMSFT and
lirenhe
as code owners
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 |
| // 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. |
There was a problem hiding this comment.
Hmm this looks wrong. Should be indented.
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.
microsoft-github-policy-service
Bot
added
the
no-recent-activity
|
Hi @@jliusan. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days. |
|
Hi @@jliusan. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing "/reopen" if you'd like to continue working on these changes. Please be sure to use the command to reopen or remove the "no-recent-activity" label; otherwise, this is likely to be closed again with the next cleanup pass. |
Add documentation test