Add documentation for glob pattern#74
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation updated to reflect glob pattern support for proto file specification in grpc configuration, effective as of version 2025.1.9. Examples added showing the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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.
Actionable comments posted: 1
🧹 Nitpick comments (1)
grpc/grpc.md (1)
448-455: Clarify that the new behavior is recursive**matching.
*.protois already a glob, so the current wording makes the old and new capabilities sound interchangeable. Calling out recursive/globstar support explicitly would make the example at Line 455 much clearer.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@grpc/grpc.md` around lines 448 - 455, The documentation currently treats "*.proto" and "some/path/**/*.proto" as similar globs; clarify that the new behavior adds recursive "globstar" support by explicitly stating that "**" performs recursive directory matching (i.e., matches across multiple directory levels), update the description for the proto field to mention that "*.proto" matches files in a single directory while "some/path/**/*.proto" uses globstar to match recursively through subdirectories, and ensure the example lines (proto: - "*.proto" - "first.proto" - "second.proto" - "some/path/**/*.proto") reflect this by adding a short note or parenthetical explaining the difference.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@grpc/grpc.md`:
- Line 346: Replace the prose "As of [2025.1.9]" with the repository's
version-tag format "[>=2025.1.9]" in the sentence that reads "You can define
multiple proto files in the `proto` section. As of [2025.1.9], one can use glob
patterns to specify multiple proto files." (also apply the same change to the
similar note at the other occurrence). Ensure both instances use the exact tag
"[>=2025.1.9]" so the docs consistently mark the support boundary.
---
Nitpick comments:
In `@grpc/grpc.md`:
- Around line 448-455: The documentation currently treats "*.proto" and
"some/path/**/*.proto" as similar globs; clarify that the new behavior adds
recursive "globstar" support by explicitly stating that "**" performs recursive
directory matching (i.e., matches across multiple directory levels), update the
description for the proto field to mention that "*.proto" matches files in a
single directory while "some/path/**/*.proto" uses globstar to match recursively
through subdirectories, and ensure the example lines (proto: - "*.proto" -
"first.proto" - "second.proto" - "some/path/**/*.proto") reflect this by adding
a short note or parenthetical explaining the difference.
|
Thank you @Nyholm 👍🏻 |
Documentation for PR roadrunner-server/grpc#145
Summary by CodeRabbit
New Features
Documentation