Skip to content

Commit e5a4cbb

Browse files
committed
Minor adjustments to UnifiedPayment docs
1 parent 80a1745 commit e5a4cbb

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

src/lib.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -941,10 +941,10 @@ impl Node {
941941
))
942942
}
943943

944-
/// Returns a payment handler allowing to create [BIP 21] URIs with an on-chain, [BOLT 11],
945-
/// and [BOLT 12] payment options.
944+
/// Returns a payment handler that supports creating and paying to [BIP 21] URIs with on-chain,
945+
/// [BOLT 11], and [BOLT 12] payment options.
946946
///
947-
/// This handler allows you to send payments to these URIs as well as [BIP 353] HRNs.
947+
/// Also supports sending payments to [BIP 353] Human-Readable Names.
948948
///
949949
/// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
950950
/// [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
@@ -962,10 +962,10 @@ impl Node {
962962
)
963963
}
964964

965-
/// Returns a payment handler allowing to create [BIP 21] URIs with an on-chain, [BOLT 11],
966-
/// and [BOLT 12] payment options.
965+
/// Returns a payment handler that supports creating and paying to [BIP 21] URIs with on-chain,
966+
/// [BOLT 11], and [BOLT 12] payment options.
967967
///
968-
/// This handler allows you to send payments to these URIs as well as [BIP 353] HRNs.
968+
/// Also supports sending payments to [BIP 353] Human-Readable Names.
969969
///
970970
/// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
971971
/// [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md

src/payment/unified.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
66
// accordance with one or both of these licenses.
77

8-
//! Holds a payment handler allowing to create [BIP 21] URIs with on-chain, [BOLT 11], and [BOLT 12] payment
9-
//! options.
8+
//! Holds a payment handler that supports creating and paying to [BIP 21] URIs with on-chain, [BOLT 11],
9+
//! and [BOLT 12] payment options.
1010
//!
11-
//! It also supports sending payments to these URIs as well as to [BIP 353] Human-Readable Names.
11+
//! Also supports sending payments to [BIP 353] Human-Readable Names.
1212
//!
1313
//! [BIP 21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki
1414
//! [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
@@ -44,12 +44,12 @@ struct Extras {
4444
bolt12_offer: Option<Offer>,
4545
}
4646

47-
/// A payment handler allowing to create [BIP 21] URIs with an on-chain, [BOLT 11], and [BOLT 12] payment
48-
/// option.
47+
/// A payment handler that supports creating and paying to [BIP 21] URIs with on-chain, [BOLT 11],
48+
/// and [BOLT 12] payment options.
4949
///
50-
/// Should be retrieved by calling [`Node::unified_payment`]
50+
/// Also supports sending payments to [BIP 353] Human-Readable Names.
5151
///
52-
/// It also supports sending payments to these URIs as well as to [BIP 353] Human-Readable Names.
52+
/// Should be retrieved by calling [`Node::unified_payment`]
5353
///
5454
/// [BIP 21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki
5555
/// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
@@ -147,7 +147,7 @@ impl UnifiedPayment {
147147
/// has an offer and or invoice, it will try to pay the offer first followed by the invoice.
148148
/// If they both fail, the on-chain payment will be paid.
149149
///
150-
/// Returns a `UnifiedPaymentResult` indicating the outcome of the payment. If an error
150+
/// Returns a [`UnifiedPaymentResult`] indicating the outcome of the payment. If an error
151151
/// occurs, an `Error` is returned detailing the issue encountered.
152152
///
153153
/// If `route_parameters` are provided they will override the default as well as the

0 commit comments

Comments
 (0)