Improve Result/unwrap docs

Co-authored-by: Nicolas Abril <[email protected]>
HigherOrderCO · Aug 7, 2024 · 2a1f077 · 2a1f077
1 parent 7ef8ff9
commit 2a1f077
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/builtins.md b/docs/builtins.md
@@ -130,6 +130,8 @@ type Result<A, B>:
 
 Returns the inner value of `Result/Ok` or `Result/Err`.
 
+If the types `A` and `B` are different, should only be used in type unsafe programs or when only one variant is guaranteed to happen.
+
 ```python
 def Result/unwrap(result: Result<A, B>): A || B
 ```