Skip to content

Commit 19f149e

Browse files
clippy: docs formatting
This is the most opinonated suggestion in this sequence of patches. Probably IDK if would be an option disable this check, but for now this commit propose a formatting fix to make clippy happy. ``` error: doc list item overindented --> lightning-types/src/features.rs:62:5 | 62 | //! onion. | ^^^ help: try using ` ` (2 spaces) | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_overindented_list_items = note: `-D clippy::doc-overindented-list-items` implied by `-D warnings` = help: to override `-D warnings` add `#[allow(clippy::doc_overindented_list_items)]` error: doc list item overindented --> lightning-types/src/features.rs:63:5 | 63 | //! (see [BOLT-11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) for | ^^^ help: try using ` ` (2 spaces) | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_overindented_list_items error: doc list item overindented --> lightning-types/src/features.rs:64:5 | 64 | //! more). | ^^^ help: try using ` ` (2 spaces) | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_overindented_list_items error: doc list item overindented --> lightning-types/src/features.rs:66:5 | 66 | //! (see | ^^^ help: try using ` ` (2 spaces) | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_overindented_list_items error: doc list item overindented --> lightning-types/src/features.rs:67:5 | 67 | //! [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-channel_ready-message) | ^^^ help: try using ` ` (2 spaces) | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_overindented_list_items error: doc list item overindented --> lightning-types/src/features.rs:68:5 | 68 | //! for more info). | ^^^ help: try using ` ` (2 spaces) | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_overindented_list_items error: could not compile `lightning-types` (lib) due to 6 previous errors ``` Signed-off-by: Vincenzo Palazzo <[email protected]>
1 parent 8dd1b39 commit 19f149e

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

lightning-types/src/features.rs

+6-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
77
// You may not use this file except in accordance with one or both of these
88
// licenses.
9-
109
//! Feature flag definitions for the Lightning protocol according to [BOLT #9].
1110
//!
1211
//! Lightning nodes advertise a supported set of operation through feature flags. Features are
@@ -59,13 +58,13 @@
5958
//! - `SCIDPrivacy` - supply channel aliases for routing
6059
//! (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md) for more information).
6160
//! - `PaymentMetadata` - include additional data in invoices which is passed to recipients in the
62-
//! onion.
63-
//! (see [BOLT-11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) for
64-
//! more).
61+
//! onion.
62+
//! (see [BOLT-11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) for
63+
//! more).
6564
//! - `ZeroConf` - supports accepting HTLCs and using channels prior to funding confirmation
66-
//! (see
67-
//! [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-channel_ready-message)
68-
//! for more info).
65+
//! (see
66+
//! [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-channel_ready-message)
67+
//! for more info).
6968
//! - `Keysend` - send funds to a node without an invoice
7069
//! (see the [`Keysend` feature assignment proposal](https://github.com/lightning/bolts/issues/605#issuecomment-606679798) for more information).
7170
//! - `Trampoline` - supports receiving and forwarding Trampoline payments

lightning/src/ln/channel.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1153,7 +1153,7 @@ pub(crate) const MIN_AFFORDABLE_HTLC_COUNT: usize = 4;
11531153
///
11541154
/// * The expected interval between ticks (1 minute).
11551155
/// * The average convergence delay of updates across the network, i.e., ~300 seconds on average
1156-
/// for a node to see an update as seen on `<https://arxiv.org/pdf/2205.12737.pdf>`.
1156+
/// for a node to see an update as seen on `<https://arxiv.org/pdf/2205.12737.pdf>`.
11571157
/// * `EXPIRE_PREV_CONFIG_TICKS` = convergence_delay / tick_interval
11581158
pub(crate) const EXPIRE_PREV_CONFIG_TICKS: usize = 5;
11591159

0 commit comments

Comments
 (0)