Repository navigation
Clarify result lifetime and consumption contracts - #3
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
This documentation-only change clarifies transient result lifetime, abandoned-request cleanup, callback republishing limitations, and the API reading path without changing runtime code or public signatures. No blocking issues found; the added guidance is consistent with the inspected store, consumer, effect, and state-helper implementations. Supplied CI reports all five checks successful. I did not independently run builds or tests, and callback republishing is not directly covered by the inspected test cases.
Clarify how applications use the existing result APIs. This is a documentation-only change: runtime behavior and public signatures are unchanged.
consume(key)overload, including nullable values, unrelated keys and late producer callbacks.The diff contains only README and KDoc changes in
ResultStore,ResultConsumerandResultEffect. Existing CI/CD, Gradle files and tests are unchanged. No Python tooling or publication-verification fixtures remain.Validation: the existing 33 library and 4 sample Android JVM tests passed, with no failures or skips.
This PR remains a draft.