Commit f7dd96f
authored
docs: correct the remote sessions client option name (#2179)
The remote sessions guide told users to enable Mission Control remote
sessions with a client option named `remote` (TypeScript) / `Remote`
(Go, C#). No such option exists. It was renamed to
`enableRemoteSessions` / `EnableRemoteSessions` during the per-language
API reviews (#1343, #1357, #1360), none of which updated this guide. The
Rust (#1367) and Python (#1376) reviews did update their own tabs, which
is why those two were already correct.
As a result, the documented client construction does not compile in
TypeScript, Go or C#.
- Correct the option name in the section lead-in and in the TypeScript,
Go and C# examples.
- Fix the Go example's return arity on the same line: NewClient returns
a single value.
- Correct the Notes bullet, which named the same nonexistent option and
also said the option applies only when the SDK spawns the CLI process.
It is honored on both the child-process and in-process host paths.
Co-authored-by: examon <examon@users.noreply.github.com>1 parent 5214bde commit f7dd96f
1 file changed
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
26 | | - | |
| 26 | + | |
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| |||
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
62 | | - | |
| 62 | + | |
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
| |||
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
81 | | - | |
| 81 | + | |
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
| |||
201 | 201 | | |
202 | 202 | | |
203 | 203 | | |
204 | | - | |
| 204 | + | |
205 | 205 | | |
206 | 206 | | |
0 commit comments