Skip to content

Commit f13bb9d

Browse files
committed
Minor adjustments to UnifiedPayment docs
1 parent 690d1f4 commit f13bb9d

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
@@ -944,10 +944,10 @@ impl Node {
944944
))
945945
}
946946

947-
/// Returns a payment handler allowing to create [BIP 21] URIs with an on-chain, [BOLT 11],
948-
/// and [BOLT 12] payment options.
947+
/// Returns a payment handler that supports creating and paying to [BIP 21] URIs with on-chain,
948+
/// [BOLT 11], and [BOLT 12] payment options.
949949
///
950-
/// This handler allows you to send payments to these URIs as well as [BIP 353] HRNs.
950+
/// Also supports sending payments to [BIP 353] Human-Readable Names.
951951
///
952952
/// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
953953
/// [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
@@ -965,10 +965,10 @@ impl Node {
965965
)
966966
}
967967

968-
/// Returns a payment handler allowing to create [BIP 21] URIs with an on-chain, [BOLT 11],
969-
/// and [BOLT 12] payment options.
968+
/// Returns a payment handler that supports creating and paying to [BIP 21] URIs with on-chain,
969+
/// [BOLT 11], and [BOLT 12] payment options.
970970
///
971-
/// This handler allows you to send payments to these URIs as well as [BIP 353] HRNs.
971+
/// Also supports sending payments to [BIP 353] Human-Readable Names.
972972
///
973973
/// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
974974
/// [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
@@ -46,12 +46,12 @@ struct Extras {
4646
bolt12_offer: Option<Offer>,
4747
}
4848

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

0 commit comments

Comments
 (0)