Update CodePathTracerRule docs to match new API

[takahirom]

What

Update documentation comments in CodePathTracerRule.kt to reflect the current API pattern

Why

The documentation was outdated - it showed the old builder pattern (CodePathTracerRule.builder()) instead of the new unified API (CodePathTracer.Builder().asJUnitRule())

[coderabbitai]

📝 Walkthrough

Walkthrough

Updates KDoc/usage examples in CodePathTracerRule.kt to reflect API rename from CodePathTracerRule.builder()/build() to CodePathTracer.Builder()/asJUnitRule(), including chaining of filter and formatter. No code logic, signatures, or runtime behavior changed.

Changes

Cohort / File(s)	Summary of changes
KDoc usage update code-path-tracer/src/main/kotlin/io/github/takahirom/codepathtracer/CodePathTracerRule.kt	Updated documentation examples: replaced CodePathTracerRule.builder() with CodePathTracer.Builder(), added chained filter and formatter, and replaced .build() with .asJUnitRule(). No functional code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Revise API design proposal to use Builder pattern #5 — Introduces the API change from CodePathTracerRule.builder()/build() to CodePathTracer.Builder()/asJUnitRule(), which this PR’s documentation updates directly reference.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch tm/update-codepathtracerrule-docs

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

code-path-tracer/src/main/kotlin/io/github/takahirom/codepathtracer/CodePathTracerRule.kt (1)

15-33: Nit: mark code fences as Kotlin for better readability.

Use ```kotlin to enable syntax highlighting in rendered KDoc.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between fd7e25b and acbe775.

📒 Files selected for processing (1)

• code-path-tracer/src/main/kotlin/io/github/takahirom/codepathtracer/CodePathTracerRule.kt (1 hunks)

🔇 Additional comments (1)

code-path-tracer/src/main/kotlin/io/github/takahirom/codepathtracer/CodePathTracerRule.kt (1)

17-21: No change needed to the JUnit4 rule snippet JUnit4 supports method-level rules via @Rule on the getter, so the existing @get:Rule example in your KDoc works as-is.

Likely an incorrect or invalid review comment.