Conversation
Add example_test.go with examples for New, Wrap, Newf, StackFrame, and errors.Is compatibility. These appear on pkg.go.dev as runnable examples. Regenerate READMEs via gomarkdoc.
There was a problem hiding this comment.
Pull request overview
Adds runnable Go examples so the github.com/go-coldbrew/errors package documentation on pkg.go.dev includes concrete usage for key APIs, and regenerates generated README docs accordingly.
Changes:
- Add
example_test.gowith Go doc examples forNew,Newf,Wrap,ErrorExt.StackFrame, anderrors.Iscompatibility. - Regenerate
README.mdto include rendered example blocks for the documented APIs. - Regenerate
notifier/README.md(including updated index entries and header badges).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds generated <details> example blocks, including an example for StackFrame. |
| notifier/README.md | Regenerated notifier package docs and updated header badges / index entries. |
| example_test.go | Introduces pkg.go.dev / go test runnable examples for core error APIs and stdlib compatibility. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Rename ExampleErrorExt_StackFrame to Example_stackFrame to fix gomarkdoc rendering "3tack Frame" typo in README - Add notifier/.gomarkdoc.yml so GoDoc badge links to the correct subpackage (errors/notifier instead of errors) - Update Makefile doc target to regenerate notifier README separately - Add examples for Wrapf, WrapWithStatus (gRPC codes), and Cause
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… for per-package docs
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
example_test.gowith examples forNew,Wrap,Newf,StackFrame, anderrors.IscompatibilityTest plan
make testpasses