docs: link to assertThrows() and assertRejects()

denoland · Feb 26, 2024 · 1adf5f3 · 1adf5f3
1 parent ce719de
commit 1adf5f3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/assert/assert_rejects.ts b/assert/assert_rejects.ts
@@ -5,6 +5,8 @@ import { assertIsError } from "./assert_is_error.ts";
 /**
  * Executes a function which returns a promise, expecting it to reject.
  *
+ * To assert that a synchronous function throws, use {@linkcode assertThrows}.
+ *
  * @example
  * ```ts
  * import { assertRejects } from "https://deno.land/std@$STD_VERSION/assert/assert_rejects.ts";
@@ -22,6 +24,8 @@ export function assertRejects(
  * If it does not, then it throws. An error class and a string that should be
  * included in the error message can also be asserted.
  *
+ * To assert that a synchronous function throws, use {@linkcode assertThrows}.
+ *
  * @example
  * ```ts
  * import { assertRejects } from "https://deno.land/std@$STD_VERSION/assert/assert_rejects.ts";

diff --git a/assert/assert_throws.ts b/assert/assert_throws.ts
@@ -6,6 +6,9 @@ import { AssertionError } from "./assertion_error.ts";
  * Executes a function, expecting it to throw. If it does not, then it
  * throws.
  *
+ * To assert that an asynchronous function rejects, use
+ * {@linkcode assertRejects}.
+ *
  * @example
  * ```ts
  * import { assertThrows } from "https://deno.land/std@$STD_VERSION/assert/assert_throws.ts";
@@ -23,6 +26,9 @@ export function assertThrows(
  * throws. An error class and a string that should be included in the
  * error message can also be asserted.
  *
+ * To assert that an asynchronous function rejects, use
+ * {@linkcode assertRejects}.
+ *
  * @example
  * ```ts
  * import { assertThrows } from "https://deno.land/std@$STD_VERSION/assert/assert_throws.ts";