docs(server): correct result-update names in README-dev request trace#89
Merged
Conversation
…t trace Epoch #86 task 2 (docs review round 2 on README-dev.md). The "Example trace of a request" section described two methods that don't exist by those names: response->update() and response->to_json(). Greppers chasing those names find nothing. The real calls are result->update(states[idx]) (inside server_response_reader::next at server-queue.cpp:396) and result->to_json() (called from multiple sites in server-context.cpp ~3854-3987). Rewrites the two affected bullets to use the actual member names and to thread the call sites through server_response_reader (which is the component that does both calls — server_res_generator is what owns the reader, but doesn't make these calls directly). No other drift found in the doc — confirmed server_routes, server_res_generator, launch_slot_with_task, task_result_state, and handle_completions_impl all exist by those names in current source.
This was referenced Jun 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Epoch #86 task 2 (docs review round 2 on README-dev.md). The "Example trace of a request" section described `response->update()` and `response->to_json()`, neither of which exists by those names. The real calls are `result->update(states[idx])` (inside `server_response_reader::next()` at `server-queue.cpp:396`) and `result->to_json()` (various sites in `server-context.cpp` ~3854-3987).
A new contributor grepping for the names in the doc finds nothing. Three-line rewrite that uses the actual member names and threads the call sites through `server_response_reader` (which is what does both calls; `server_res_generator` owns the reader but doesn't call them directly).
Audit scope
Spot-checked all named symbols in the doc — `server_routes`, `server_res_generator`, `launch_slot_with_task`, `task_result_state`, `handle_completions_impl` all exist by those names. Only the two method names were drifting.
Test plan
🤖 Generated with Claude Code