From 6fa97fb745558b9aeca2eca8c5d9066b8d8faf27 Mon Sep 17 00:00:00 2001
From: MokaStitcher <54149968+MokaStitcher@users.noreply.github.com>
Date: Mon, 16 Sep 2024 17:39:52 +0200
Subject: [PATCH] Improve documentation based on suggestions

Co-authored-by: NightKev <34855794+DayKev@users.noreply.github.com>
---
 src/overrides.ts | 2 +-
 src/tutorial.ts  | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/overrides.ts b/src/overrides.ts
index 2e459673e02..ec0577ceb3d 100644
--- a/src/overrides.ts
+++ b/src/overrides.ts
@@ -70,7 +70,7 @@ class DefaultOverrides {
       [PokeballType.MASTER_BALL]: 0,
     },
   };
-  /** Set to true to show all tutorials */
+  /** Set to `true` to show all tutorials */
   readonly BYPASS_TUTORIAL_SKIP: boolean = false;
 
   // ----------------
diff --git a/src/tutorial.ts b/src/tutorial.ts
index 28780210418..18d8291d227 100644
--- a/src/tutorial.ts
+++ b/src/tutorial.ts
@@ -71,7 +71,7 @@ const tutorialHandlers = {
  * The main menu will also get disabled while the tutorial is running
  * @param scene the current {@linkcode BattleScene}
  * @param tutorial the {@linkcode Tutorial} to play
- * @returns a promise with result true is the tutorial was run and finished, false otherwise
+ * @returns a promise with result `true` if the tutorial was run and finished, `false` otherwise
  */
 export async function handleTutorial(scene: BattleScene, tutorial: Tutorial): Promise<boolean> {
   if (!scene.enableTutorials && !Overrides.BYPASS_TUTORIAL_SKIP) {
@@ -109,7 +109,7 @@ export async function handleTutorial(scene: BattleScene, tutorial: Tutorial): Pr
  * Show the tutorial overlay if there is one
  * @param scene the current BattleScene
  * @param handler the current UiHandler
- * @returns true once the overlay has finished appearing, or if there is no overlay
+ * @returns `true` once the overlay has finished appearing, or if there is no overlay
  */
 async function showTutorialOverlay(scene: BattleScene, handler: UiHandler) {
   if (handler instanceof AwaitableUiHandler && handler.tutorialOverlay) {
@@ -131,7 +131,7 @@ async function showTutorialOverlay(scene: BattleScene, handler: UiHandler) {
  * Hide the tutorial overlay if there is one
  * @param scene the current BattleScene
  * @param handler the current UiHandler
- * @returns true once the overlay has finished disappearing, or if there is no overlay
+ * @returns `true` once the overlay has finished disappearing, or if there is no overlay
  */
 async function hideTutorialOverlay(scene: BattleScene, handler: UiHandler) {
   if (handler instanceof AwaitableUiHandler && handler.tutorialOverlay) {