docs: fix doc-drift, sharpen positioning, record consolidation backlog#38
Conversation
Cheap, doc-only hygiene from an external architecture review; the larger structural items are recorded as a deferred backlog rather than done now. - ROADMAP: the "frontend does NOT touch closures / interprocedural" note drifted from reality. Carve out the two honest exceptions that already exist: syntactic lambda-event-handler classification, and bounded *modular* interprocedural (ownership contracts + inference) in the CORE, not the frontend (P-006/2b). - ROADMAP framing: state plainly that Own.NET is one resource/lifetime analyzer WITH profiles, WPF is the first profile (not the identity); the engine emits domain-neutral OWN codes + a profile label. - lifetimes.md: note the naming convention -- WPFxxx are pattern-catalog IDs, not emitted codes (the engine emits OWN001/002/003/014 + [resource]/[profile]). - New docs/notes/consolidation-and-positioning.md records the review's verdict and the DEFERRED items (OwnIR v1 schema rename, extractor split, WPFxxx->SUB/TMR/DISP catalog rename) with cost/benefit and the trigger that should pull each off the shelf -- plus the honest meta-point that the highest-leverage next move is proving value (oracle on real repos), not reshaping form. No code change; full suite, ruff, mypy --strict unaffected. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Rg8kSk1YT14x7A1vo5zgED
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (3)
📝 WalkthroughWalkthroughThree documentation files are updated. ChangesDocumentation cleanup and consolidation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4b5d6fa291
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
The positioning edits promised the engine emits a `[profile: wpf]` label, but the renderers only carry/render a resource kind: `ownlang/diagnostics.py` emits ` [resource: ...]` from `resource_kind`, and `ownlang/ownir.py` renders human/GitHub/MSBuild findings with `[resource: ...]` only. Anyone asserting CLI output would look for metadata the tool never emits. Fix (docs-only, in the spirit of this doc-accuracy PR): say the engine emits the core code + a `[resource: ...]` kind tag, and note a dedicated `[profile: ...]` label is NOT emitted today -- it is a consolidation-backlog item. ROADMAP, lifetimes.md catalog note, and the consolidation note all corrected. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Rg8kSk1YT14x7A1vo5zgED
…cle run CodeRabbit (PR #41) correctly flagged that the note cited oracle.md / real-world-mining.md as evidence for a WalletWasabi 3-way oracle run, but those files document the ScreenToGif and Dapper runs — WalletWasabi is not written up anywhere in docs/. The WalletWasabi mining/oracle happened in CI but its result was never distilled into the repo, so the citation was broken. Retarget the "differentiation is already demonstrated" claim to the *documented* ScreenToGif oracle result (SystemEvents error + VideoSource warnings, own-only; CodeQL has no "subscribed-never-unsubscribed" query, Infer# misses it too — all in real-world-mining.md "Cross-tool validation"), and label the larger WalletWasabi run honestly as "exercised in CI, not yet distilled into a committed corpus artifact" — which is precisely the benchmark-corpus backlog item, not a result to lean on. Same fix in the backlog bullet. The other flagged reference (consolidation-and-positioning.md) was a merge-timing artifact: it lives in #38, which merged ~3 min after the review; the branch is now rebased onto main, so the file is present. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Rg8kSk1YT14x7A1vo5zgED
Cheap, doc-only hygiene from an external architecture review; the larger structural items are recorded as a deferred backlog rather than done now (the review's own "strengthen the form, don't expand the dream" advice — and its blind spot, since it was a read-only pass, is recorded too).
OWN001/002/003/014+ a profile label.docs/lifetimes.md:WPFxxxare pattern-catalog IDs, not emitted codes.docs/notes/consolidation-and-positioning.mdrecords the deferred items (OwnIR v1 schema rename, extractor split,WPFxxx → SUB/TMR/DISPcatalog rename) with cost/benefit and the trigger that should pull each off the shelf — plus the honest note that the highest-leverage next move is proving value (oracle on real repos), not reshaping form.No code change; full suite, ruff, mypy
--strictunaffected.🤖 Generated with Claude Code
https://claude.ai/code/session_01Rg8kSk1YT14x7A1vo5zgED
Generated by Claude Code
Summary by CodeRabbit