Skip to content

docs(codegen): correct streams FFI module summary - #10979

Closed
proggeramlug wants to merge 2 commits into
mainfrom
fix/10726-streams-ffi-doc
Closed

proggeramlug wants to merge 2 commits into
mainfrom
fix/10726-streams-ffi-doc

Conversation

@proggeramlug

@proggeramlug proggeramlug commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #10726.

The streams_events.rs module summary listed validator, fastify, and rate-limit after their FFI declarations had been removed. It now lists only the groups declared in that module.

Verification: inspected all declarations in the module, checked the summary against them, and ran git diff --check.

Summary by CodeRabbit

  • Documentation
    • Corrected the streams/events FFI module documentation to list only the declarations currently present.
    • Removed outdated references to fastify, rate-limit, and validator.

@coderabbitai

coderabbitai Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 2243e410-6483-4b03-b077-a1eda0b937f2

📥 Commits

Reviewing files that changed from the base of the PR and between c1569e2 and 79d838f.

📒 Files selected for processing (2)
  • changelog.d/10979-streams-ffi-summary.md
  • crates/perry-codegen/src/runtime_decls/stdlib_ffi/streams_events.rs

Included review availability: Your plan provides up to 8 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The streams/events FFI module documentation now lists only declarations still present in the module. A changelog entry records this correction.

Changes

Stdlib FFI documentation

Layer / File(s) Summary
Update module documentation
crates/perry-codegen/src/runtime_decls/stdlib_ffi/streams_events.rs, changelog.d/10979-streams-ffi-summary.md
The module comment removes fastify, rate-limit, and validator. The changelog records the corrected declaration summary.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other · Severity of issue fixed: Low

Merge Risk: 🔵 Low · up to 79d83

This documentation-only change is low risk, but the nearby dispatcher comment still names removed FFI groups and should be corrected as a follow-up.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation correction in the streams FFI module summary.
Description check ✅ Passed The description explains the change, references issue #10726, and records the verification performed. It does not reproduce the template headings or checklist, but it contains the required information…
Linked Issues check ✅ Passed The PR addresses issue #10726. It updates crates/perry-codegen/src/runtime_decls/stdlib_ffi/streams_events.rs and removes fastify, rate-limit, and validator from the module summary. The report…
Out of Scope Changes check ✅ Passed The reported changes are limited to the target module doc-comment and a changelog fragment for PR #10979. Both changes document the correction required by issue #10726. No unrelated source or behavior…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
✨ Finishing Touches 💡 1
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR

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.

@proggeramlug

Copy link
Copy Markdown
Contributor Author

Landed on main in merge train 256 (#11018, v0.5.1638), main f5cfbff882.

Carried at head 79d838f409. The landed tree is byte-identical to the validated train tree (9b108dd3c9), and CI on the train head passed every job except the known public-baseline lint step: all 6 gap shards, cargo-test, e2e-scoped, gc-stress, check, warnings and security-audit green.

Trains rebase-merge, so commits get new SHAs and GitHub cannot mark this PR merged. Closed as landed.

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.

streams_events.rs module doc-comment still lists "validator" after its FFI declarations were removed

1 participant