Clarify work.stop() limitation (#16073)

Lightning-AI · Dec 19, 2022 · 0abd686 · 0abd686
1 parent 2a85d9b
commit 0abd686
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/src/lightning_app/core/work.py b/src/lightning_app/core/work.py
@@ -630,12 +630,12 @@ def on_exit(self):
         pass
 
     def stop(self):
-        """Stops LightingWork component and shuts down hardware provisioned via L.CloudCompute."""
+        """Stops LightingWork component and shuts down hardware provisioned via L.CloudCompute.
+
+        This can only be called from a ``LightningFlow``.
+        """
         if not self._backend:
-            raise Exception(
-                "Can't stop the work, it looks like it isn't attached to a LightningFlow. "
-                "Make sure to assign the Work to a flow instance."
-            )
+            raise RuntimeError(f"Only the `LightningFlow` can request this work ({self.name!r}) to stop.")
         if self.status.stage == WorkStageStatus.STOPPED:
             return
         latest_hash = self._calls[CacheCallsKeys.LATEST_CALL_HASH]