Merge pull request #2876 from TheBlueMatt/2024-02-2863-doc-nits

Minor doc nits on the new coop close reason variants

diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs
index 3bc70014f49aab63105ae94409e94025677ff8ab..d08d3c5ac6ba163b100e5392a4b86cea8fce6841 100644 (file)
--- a/lightning/src/events/mod.rs
+++ b/lightning/src/events/mod.rs
@@ -184,11 +184,16 @@ pub enum ClosureReason {
        HolderForceClosed,
        /// The channel was closed after negotiating a cooperative close and we've now broadcasted
        /// the cooperative close transaction. Note the shutdown may have been initiated by us.
+       ///
+       /// This was only set in versions of LDK prior to 0.0.122.
        // Can be removed once we disallow downgrading to 0.0.121
        LegacyCooperativeClosure,
        /// The channel was closed after negotiating a cooperative close and we've now broadcasted
        /// the cooperative close transaction. This indicates that the shutdown was initiated by our
        /// counterparty.
+       ///
+       /// In rare cases where we initiated closure immediately prior to shutting down without
+       /// persisting, this value may be provided for channels we initiated closure for.
        CounterpartyInitiatedCooperativeClosure,
        /// The channel was closed after negotiating a cooperative close and we've now broadcasted
        /// the cooperative close transaction. This indicates that the shutdown was initiated by us.