Skip to content

Commit f2edd89

Browse files
committed
f even better docs
1 parent 8c5aae0 commit f2edd89

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

lightning/src/util/ser_macros.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1065,9 +1065,9 @@ macro_rules! impl_writeable_tlv_based_enum {
10651065
/// when [`MaybeReadable`] is practical instead of just [`Readable`] as it provides an upgrade path for
10661066
/// new variants to be added which are simply ignored by existing clients.
10671067
///
1068-
/// Note that variants written as tuple variants will not support downgrading no matter the
1069-
/// `$tuple_variant_id` used. Any variants written as a normal variant will support downgrading by
1070-
/// having [`MaybeReadable`] return `None` for odd `$variant_id` variants not understood.
1068+
/// Note that only normal variants (not tuple variants) will support downgrading, thus any new odd
1069+
/// variants MUST be normal (i.e. described using `$variant_id` and `$variant_name` not
1070+
/// `$tuple_variant_id` and `$tuple_variant_name`).
10711071
///
10721072
/// [`MaybeReadable`]: crate::util::ser::MaybeReadable
10731073
/// [`Writeable`]: crate::util::ser::Writeable

0 commit comments

Comments
 (0)