|
5 | 5 | // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in |
6 | 6 | // accordance with one or both of these licenses. |
7 | 7 |
|
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. |
10 | 10 | //! |
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. |
12 | 12 | //! |
13 | 13 | //! [BIP 21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki |
14 | 14 | //! [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki |
@@ -44,12 +44,12 @@ struct Extras { |
44 | 44 | bolt12_offer: Option<Offer>, |
45 | 45 | } |
46 | 46 |
|
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. |
49 | 49 | /// |
50 | | -/// Should be retrieved by calling [`Node::unified_payment`] |
| 50 | +/// Also supports sending payments to [BIP 353] Human-Readable Names. |
51 | 51 | /// |
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`] |
53 | 53 | /// |
54 | 54 | /// [BIP 21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki |
55 | 55 | /// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki |
@@ -147,7 +147,7 @@ impl UnifiedPayment { |
147 | 147 | /// has an offer and or invoice, it will try to pay the offer first followed by the invoice. |
148 | 148 | /// If they both fail, the on-chain payment will be paid. |
149 | 149 | /// |
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 |
151 | 151 | /// occurs, an `Error` is returned detailing the issue encountered. |
152 | 152 | /// |
153 | 153 | /// If `route_parameters` are provided they will override the default as well as the |
|
0 commit comments