From 3bf635ffabdad8736aae010f5d11abf5cdcf21c8 Mon Sep 17 00:00:00 2001
From: Tyler J Russell <22531310+Nytelife26@users.noreply.github.com>
Date: Mon, 12 Apr 2021 18:19:40 +0100
Subject: [PATCH] docs: update example for abort controllers

---
 src/lib/PetitioRequest.ts | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/src/lib/PetitioRequest.ts b/src/lib/PetitioRequest.ts
index 43ea95e..182c591 100644
--- a/src/lib/PetitioRequest.ts
+++ b/src/lib/PetitioRequest.ts
@@ -137,9 +137,13 @@ export class PetitioRequest {
 	/**
 	 * @param {AbortController} controller A controller instance that handles aborting the request.
 	 * @return {*} The request object for further composition.
-	 * @example Initiate a AbortController class and then attach it to the request object
-	 * by doing `.signal(the_controller)`. Then you can abort the request by running
-	 * the abort() function on the controller you created.
+	 * @example
+	 * ```ts
+	 * const controller = new AbortController();
+	 * const result = petitio(URL).signal(controller);
+	 * setTimeout(() => controller.abort(), 5000) // serves as a request timeout
+	 * ```
+	 */
 	 */
 	public signal(controller: AbortController): this {
 		this.controller = controller;