Skip to content

Commit 7e9700a

Browse files
committed
docs(protocol): fix typedoc inline-tag brace warning in drain JSDoc
The open brace in {@linkcode Protocol.close | close({ drainPendingRequests })} is flagged by typedoc ('Encountered an open brace within an inline tag'), which fails the docs:check CI gate. Use plain backticks for the call form.
1 parent c6abb6d commit 7e9700a

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

packages/core-internal/src/shared/protocol.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1281,11 +1281,11 @@ export abstract class Protocol<ContextT extends BaseContext> {
12811281
* in which case the caller proceeds with a hard close and the stragglers
12821282
* settle via {@linkcode Protocol._onclose | _onclose}. Never rejects.
12831283
*
1284-
* Used by the opt-in graceful close ({@linkcode Protocol.close |
1285-
* close({ drainPendingRequests })}): without draining, the transport's
1286-
* teardown aborts in-flight HTTP requests that had already been answered,
1287-
* which instrumentation such as OpenTelemetry's undici instrumentation
1288-
* reports as aborted requests (modelcontextprotocol/typescript-sdk#1231).
1284+
* Used by the opt-in graceful close (`close({ drainPendingRequests })`):
1285+
* without draining, the transport's teardown aborts in-flight HTTP
1286+
* requests that had already been answered, which instrumentation such as
1287+
* OpenTelemetry's undici instrumentation reports as aborted requests
1288+
* (modelcontextprotocol/typescript-sdk#1231).
12891289
*/
12901290
protected _drainPendingRequests(timeoutMs: number): Promise<boolean> {
12911291
if (this._pendingRequestIds.size === 0) {

0 commit comments

Comments
 (0)