From db6427b456df609b879a3e02083bb11e57e8398e Mon Sep 17 00:00:00 2001
From: Ralf Jung <post@ralfj.de>
Date: Sat, 21 Sep 2024 09:17:31 +0200
Subject: [PATCH] ABI compatibility: mention Result guarantee

---
 core/src/primitive_docs.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/core/src/primitive_docs.rs b/core/src/primitive_docs.rs
index 5451e45f6c817..962da6643ddb1 100644
--- a/core/src/primitive_docs.rs
+++ b/core/src/primitive_docs.rs
@@ -1761,6 +1761,8 @@ mod prim_ref {}
 /// - `i32` is ABI-compatible with `NonZero<i32>`, and similar for all other integer types.
 /// - If `T` is guaranteed to be subject to the [null pointer
 ///   optimization](option/index.html#representation), then `T` and `Option<T>` are ABI-compatible.
+///   Furthermore, if `U` satisfies the requirements [outlined here](result/index.html#representation),
+///   then `T` and `Result<T, U>` and `Result<U, T>` are all ABI-compatible.
 ///
 /// Furthermore, ABI compatibility satisfies the following general properties:
 ///