From 3218c6a845d864d3e209c49495a58ee61e2e4b98 Mon Sep 17 00:00:00 2001
From: Ben Challis <ben-challis@users.noreply.github.com>
Date: Fri, 1 Sep 2023 10:14:09 +0100
Subject: [PATCH] Document MigrationStuck being thrown from Migrator::migrate()
 (#170)

---
 src/Migration/Migrator.php | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/Migration/Migrator.php b/src/Migration/Migrator.php
index d397907..0bf968b 100644
--- a/src/Migration/Migrator.php
+++ b/src/Migration/Migrator.php
@@ -25,6 +25,8 @@ public function __construct(private Migrations $migrations, private Executor $ex
     /**
      * @param Mutex $mutex A mutex to ensure that migrations cannot be run concurrently and race condition
      * against each other.
+     *
+     * @throws MigrationStuck If a migration is stuck in a state which requires manual intervention
      */
     public function migrate(Mutex $mutex): void
     {