From e9ff99101b9800f36839e6158d544c8ef5938d22 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:16:51 +0000 Subject: [PATCH] docs: Remove hyphen after `@returns` (#9989) docs: remove hyphen after `@returns` Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> --- packages/proxy/src/util/responseHelpers.ts | 2 +- packages/rest/src/lib/handlers/Shared.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/proxy/src/util/responseHelpers.ts b/packages/proxy/src/util/responseHelpers.ts index 0c036aac8..937a772ab 100644 --- a/packages/proxy/src/util/responseHelpers.ts +++ b/packages/proxy/src/util/responseHelpers.ts @@ -67,7 +67,7 @@ export function populateAbortErrorResponse(res: ServerResponse): void { * * @param res - The server response to populate * @param error - The error to check and use - * @returns - True if the error is known and the response object was populated, otherwise false + * @returns `true` if the error is known and the response object was populated, otherwise `false` */ export function populateErrorResponse(res: ServerResponse, error: unknown): boolean { if (error instanceof DiscordAPIError || error instanceof HTTPError) { diff --git a/packages/rest/src/lib/handlers/Shared.ts b/packages/rest/src/lib/handlers/Shared.ts index a1eeeb061..53d4c72af 100644 --- a/packages/rest/src/lib/handlers/Shared.ts +++ b/packages/rest/src/lib/handlers/Shared.ts @@ -115,7 +115,7 @@ export async function makeNetworkRequest( * @param url - The fully resolved url to make the request to * @param requestData - Extra data from the user's request needed for errors and additional processing * @param retries - The number of retries this request has already attempted (recursion occurs on the handler) - * @returns - The response if the status code is not handled or null to request a retry + * @returns The response if the status code is not handled or null to request a retry */ export async function handleErrors( manager: REST,