Fix docs for `CtrlMsg::ConfigUpdate`

Prompted by
  https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/586#note_2813565
This commit is contained in:
Ian Jackson 2022-06-16 16:14:23 +01:00
parent 54c7070b30
commit 2d97ab3677
1 changed files with 2 additions and 5 deletions

View File

@ -70,14 +70,11 @@ pub(super) enum CtrlMsg {
},
/// Enable/disable/reconfigure channel padding
///
/// `bool` is whether to send padding.
/// `padding::Parameters` is an optional update to the timing parameters;
/// if not present, previously stored parameters should be used.
///
/// The sender of these messages is responsible for the optimisation of
/// ensuring that "no-change" messages are elided.
/// (This is implemented in `ChannelsConfigUpdatesBuilder`.)
///
/// This is done via a control message to avoid adding additional branches to the
/// These updates are done via a control message to avoid adding additional branches to the
/// main reactor `select!`.
ConfigUpdate(Arc<ChannelsConfigUpdates>),
}