From 0d2eeae5b0055c309ef20171d5066f07ea196d77 Mon Sep 17 00:00:00 2001 From: "coderabbitai[bot]" <136622811+coderabbitai[bot]@users.noreply.github.com> Date: Fri, 24 Oct 2025 18:23:28 +0000 Subject: [PATCH] docs: Add docstrings to `test-whole` Docstrings generation was requested by @snipsnipsnip. * https://github.com/exteditor/ghostbird/pull/49#issuecomment-3444234202 --- src/thunderbird/util/promisified_message_port.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/thunderbird/util/promisified_message_port.ts b/src/thunderbird/util/promisified_message_port.ts index 1c026d7..187aa5c 100644 --- a/src/thunderbird/util/promisified_message_port.ts +++ b/src/thunderbird/util/promisified_message_port.ts @@ -2,9 +2,11 @@ import type { IMessagePort } from "src/ghosttext-runner" import { PromisifyingQueue } from "src/util/promisifying_queue" /** - * Create a pair of PromisifiedMessagePort from a MessageChannel. - * @template TRequest The type of messages which port1 can sends, and port2 expects to receive - * @template TResponse The type of messages which port1 expects to receive, and port2 can send + * Creates a pair of promisified message ports from a MessageChannel. + * + * @template TRequest The type of messages the first returned port can send and the second expects to receive + * @template TResponse The type of messages the first returned port expects to receive and the second can send + * @returns A tuple `[IMessagePort, IMessagePort]` where the first element is a promisified port for sending `TRequest` and receiving `TResponse`, and the second element is a promisified port for sending `TResponse` and receiving `TRequest` */ export function promisifyMessageChannel({ port1,