Repository navigation
Point README at the manual - #29
Conversation
README and the manual page carried the same technical content and had drifted (the README got the install-order fix and 0.4.0 hardening, the manual did not). The manual is now the canonical reference; README keeps the example, install, the execution-mode table, links, and the demo commands. The 0.4.0 migration note linked a README section that no longer exists; it now links the manual section.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe README now provides a concise overview of parallel ChangesDocumentation alignment
Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: ⚪ Minimal · up to The README and migration guidance now direct users to the canonical async manual while retaining installation, execution, and demo guidance. No current merge-blocking product risk is identified. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
|
@coderabbitai review |
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
The four pool module usage examples still installed PackageModule before AsyncSwooleModule, the order #28 corrected everywhere else. Ray.Di keeps the first binding, so the examples as written left #[Embed] sequential.
Installing AsyncSwooleModule inside AppModule makes every entrypoint
async and is the only reason the PackageModule ordering mattered.
BEAR.Package resolves the swoole context token to
{App}\Module\SwooleModule and wraps AppModule with it, so the async
bindings take precedence by construction and AppModule stays sequential
for bin/app.php. The demo already works this way. Usage examples in the
six module docblocks, the README table, and the changelog line now show
the context module.
|
Two follow-up commits:
No code change; |
|
@coderabbitai review |
|
AsyncEmbedModule said twice that AsyncSwooleModule includes it; the pool modules repeated "AppModule stays unchanged" five times across the package; the AsyncSwooleModule note explained bin/app.php, which is the manual's job. Keep the one warning that guards a silent failure (not inside AppModule) in AsyncSwooleModule only, and list ext-openswoole in its requirements.
README and the manual page (https://bearsunday.github.io/manuals/1.0/en/async.html) carried the same technical content and had drifted. The manual is now the canonical reference (bearsunday/bearsunday.github.io#401); README keeps the example, install, the execution-mode table, links, and the demo commands.
The 0.4.0 migration note linked a README section that no longer exists; it now links the manual section.
Merge after bearsunday/bearsunday.github.io#401 so the section anchors resolve.