From f839c077f63c11bc4569022e186c4f134b3e72a6 Mon Sep 17 00:00:00 2001
From: Eric Gilmore <egilmore@google.com>
Date: Wed, 22 Jan 2025 15:13:51 -0800
Subject: [PATCH] Initial tweaks to streaming-related API.

---
 src/common/providers/https.ts | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/common/providers/https.ts b/src/common/providers/https.ts
index a6989f130..215d2d866 100644
--- a/src/common/providers/https.ts
+++ b/src/common/providers/https.ts
@@ -123,7 +123,7 @@ export interface CallableRequest<T = any> {
   data: T;
 
   /**
-   * The result of decoding and verifying a Firebase AppCheck token.
+   * The result of decoding and verifying a Firebase App Check token.
    */
   app?: AppCheckData;
 
@@ -145,15 +145,15 @@ export interface CallableRequest<T = any> {
   /**
    * Whether this is a streaming request.
    * Code can be optimized by not trying to generate a stream of chunks to
-   * call response.sendChunk on if request.acceptsStreaming is false.
-   * It is always safe, however, to call response.sendChunk as this will
-   * noop if acceptsStreaming is false.
+   * call `response.sendChunk` if `request.acceptsStreaming` is false.
+   * It is always safe, however, to call `response.sendChunk` as this will
+   * noop if `acceptsStreaming` is false.
    */
   acceptsStreaming: boolean;
 }
 
 /**
- * CallableProxyResponse allows streaming response chunks and listening to signals
+ * `CallableProxyResponse` allows streaming response chunks and listening to signals
  * triggered in events such as a disconnect.
  */
 export interface CallableResponse<T = unknown> {
@@ -166,7 +166,7 @@ export interface CallableResponse<T = unknown> {
   sendChunk: (chunk: T) => Promise<boolean>;
 
   /**
-   * An AbortSignal that is triggered when the client disconnects or the
+   * An `AbortSignal` that is triggered when the client disconnects or the
    * request is terminated prematurely.
    */
   signal: AbortSignal;