Commit 5462727
committed
docs: address review feedback (nine small fixes across ten files)
A review pass left 13 comments; nine needed action and each fix is a
word or a line.
- testing.md over-claimed that every example runs "through exactly this
client". Every example file IS exercised by the suite, but two of the
42 docs test modules never construct a Client (the OAuth examples
cannot be driven that way), so it now says "almost all of them".
- oauth-clients.md's "Every other example in these docs you can check
with an in-memory Client(server)" had the same shape (the identity
assertion example cannot be either); now "Most examples".
- handling-errors.md's new hand-off promised Troubleshooting covers
"every error the SDK produces". The Troubleshooting page scopes
itself the honest way round, so the hand-off now matches it.
- dependencies.md's closing hand-off read "State your server builds
once at startup ... is the Lifespan", which garden-paths as an
imperative; it gained its determiner and its head noun.
- asgi.md's tip said "the next section is what host= actually
controls", but this PR moved that explanation to Deploy & scale; the
tip now points there.
- media.md gains a relative pronoun: "the TextContent that a plain str
result becomes".
- README's two get-started links still pointed at the old /v2/tutorial/
URL, which this PR turns into a redirect stub; both now point at
/v2/get-started/.
- docs/hooks/llms_txt.py's docstring example path named the removed
tutorial/ directory; it now names the moved page's real path.
- RELEASE.md's list of version-pin locations gains the new
docs/get-started/real-host.md (which pins the version seven times),
and examples/README.md no longer claims the simple-auth pair is
linked from docs/advanced/ (this PR moved every page that links it).
Two other comments were already addressed by earlier commits on this
branch (the chapter-to-page sweep and the branch-coverage fix), and two
were declined with evidence. The claimed "sentence fragment" in
media.md is a complete sentence (a contact relative clause) read one
wrapped line at a time. And gating the deploy example's refund on
request_state instead of input_responses would not add a
human-confirmation guarantee: input_responses is a wire parameter only
the MCP client can send, and that same client authors the elicitation
answer on the honest second round; the SDK's own Client documents
seeding input_responses on the first call.1 parent 2996a29 commit 5462727
10 files changed
Lines changed: 13 additions & 13 deletions
File tree
- docs
- client
- get-started
- handlers
- hooks
- run
- servers
- examples
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
| 27 | + | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
| |||
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
85 | | - | |
| 85 | + | |
86 | 86 | | |
87 | 87 | | |
88 | 88 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
38 | | - | |
| 38 | + | |
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
87 | 87 | | |
88 | 88 | | |
89 | 89 | | |
90 | | - | |
| 90 | + | |
91 | 91 | | |
92 | 92 | | |
93 | 93 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
99 | 99 | | |
100 | 100 | | |
101 | 101 | | |
102 | | - | |
103 | | - | |
| 102 | + | |
| 103 | + | |
104 | 104 | | |
105 | 105 | | |
106 | 106 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
142 | 142 | | |
143 | 143 | | |
144 | 144 | | |
145 | | - | |
| 145 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
34 | | - | |
| 33 | + | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
131 | 131 | | |
132 | 132 | | |
133 | 133 | | |
134 | | - | |
| 134 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
19 | | - | |
| 19 | + | |
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
0 commit comments