Document fatal errors not handled by Failure

2bllw8 · Jun 28, 2022 · 5231010 · 5231010
1 parent a0e0bfd
commit 5231010
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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