From 523101098d47fa09c5be5c5e53fa303c37e8332b Mon Sep 17 00:00:00 2001
From: 2bllw8 <2bllw8@gmail.com>
Date: Tue, 28 Jun 2022 11:05:44 +0200
Subject: [PATCH] Document fatal errors not handled by Failure

---
 lib/src/main/java/exe/bbllw8/either/Failure.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/lib/src/main/java/exe/bbllw8/either/Failure.java b/lib/src/main/java/exe/bbllw8/either/Failure.java
index af8f0eb..c96e4e0 100644
--- a/lib/src/main/java/exe/bbllw8/either/Failure.java
+++ b/lib/src/main/java/exe/bbllw8/either/Failure.java
@@ -13,6 +13,13 @@
 /**
  * A failure that occurred during a computation wrapped in a {@link Try} type. Holds a
  * {@link Throwable} object that represents the failure point.
+ * <p>
+ * Note: instances of the following classes are not handled:
+ * <ul>
+ *     <li>{@link LinkageError}</li>
+ *     <li>{@link ThreadDeath}</li>
+ *     <li>{@link VirtualMachineError}</li>
+ * </ul>
  *
  * @author 2bllw8
  * @since 3.0.0