docs: Remove hyphen after @returns (#9989)

docs: remove hyphen after `@returns` Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
discordjs · Nov 21, 2023 · e9ff991 · e9ff991
1 parent 3d1c884
commit e9ff991
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git 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
@@ -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,