[Bug] README line 47 contradicts docs/rlm.md on rlm() return semantics #1879
belumume
started this conversation in
Bug reports
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
README.mdline 47 states:packages/coding-agent/docs/rlm.mdstates the opposite, twice:agent_messagereplies or files, never as anrlm()return value."The launch post agrees with the docs, not the README: "rlm() returns at task admission with a child handle, never the child's answer; results arrive as agent_message replies."
Why this is worth a line change rather than a wording nit: the README sentence leads directly to
and to treating
resultsas the child's answer. That does not raise, because the admission handle is a real object with useful attributes, so the mistake surfaces later as a child whose output never appears. Anyone whose first contact with the API is the README meets the correct model only after their first orchestration misbehaves.Suggested replacement for line 47, docs-only, no behavior change:
Checked against v0.8.1. I searched the existing Discussions and did not find a prior report of this one.
All reactions