From d15783dba0853541888c8e0c5d4caf22106a9840 Mon Sep 17 00:00:00 2001
From: Ed Ball <ed@xsats.com>
Date: Wed, 1 Feb 2023 13:41:15 +0100
Subject: [PATCH] add missing bdk-ffi AddressIndex Peek docstrings

---
 bdk-ffi/src/lib.rs | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/bdk-ffi/src/lib.rs b/bdk-ffi/src/lib.rs
index 7acb254..6389fbc 100644
--- a/bdk-ffi/src/lib.rs
+++ b/bdk-ffi/src/lib.rs
@@ -69,9 +69,11 @@ pub enum AddressIndex {
     /// caller is untrusted; for example when deriving donation addresses on-demand for a public
     /// web page.
     LastUnused,
-    Peek {
-        index: u32,
-    },
+    /// Return the address for a specific descriptor index. Does not change the current descriptor
+    /// index used by `AddressIndex::New` and `AddressIndex::LastUsed`.
+    /// Use with caution, if an index is given that is less than the current descriptor index
+    /// then the returned address may have already been used.
+    Peek { index: u32 },
 }
 
 impl From<AddressIndex> for BdkAddressIndex {