Skip to content

Add Go example tests for pkg.go.dev#9

Merged
ankurs merged 2 commits intomainfrom
feat/example-tests
Mar 24, 2026
Merged

Add Go example tests for pkg.go.dev#9
ankurs merged 2 commits intomainfrom
feat/example-tests

Conversation

@ankurs
Copy link
Copy Markdown
Member

@ankurs ankurs commented Mar 23, 2026

Summary

  • Add example_test.go with examples for AddToOptions and FromContext
  • Examples appear on pkg.go.dev as runnable documentation
  • Regenerate README via gomarkdoc

Test plan

  • make test passes
  • Verify examples appear on pkg.go.dev after merge

Add example_test.go with examples for AddToOptions and FromContext.
Regenerate README via gomarkdoc.
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds Go example tests intended to surface as runnable documentation on pkg.go.dev, and regenerates the README via gomarkdoc to include those examples.

Changes:

  • Add example_test.go with ExampleAddToOptions and ExampleFromContext.
  • Update README.md to include the generated example sections for AddToOptions and FromContext.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
example_test.go Adds runnable Go doc examples for AddToOptions and FromContext.
README.md Regenerated gomarkdoc output to embed the new examples in rendered docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread example_test.go Outdated
Comment thread README.md Outdated
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 24, 2026

Warning

Rate limit exceeded

@ankurs has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 20 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d07d8149-6bc2-471b-81da-a334e921b6a7

📥 Commits

Reviewing files that changed from the base of the PR and between d055bbd and ba3b855.

📒 Files selected for processing (3)
  • README.md
  • example_test.go
  • options.go
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/example-tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 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.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 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.

@ankurs ankurs merged commit 21220ca into main Mar 24, 2026
16 checks passed
@ankurs ankurs deleted the feat/example-tests branch March 24, 2026 01:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants