Skip to content

Commit b10a7fe

Browse files
committed
f Use next_event as example in docs
.. as `wait_next_event` is only available in `std`, leaving docs otherwise broken in no-std.
1 parent 2454afd commit b10a7fe

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

lightning-liquidity/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ from the incoming payment, i.e., no funds are required client-side to initiate t
1212

1313
To get started, you'll want to setup a `LiquidityManager` and configure it to be the `CustomMessageHandler` of your LDK node. You can then call `LiquidityManager::lsps1_client_handler` / `LiquidityManager::lsps2_client_handler`, or `LiquidityManager::lsps2_service_handler`, to access the respective client-side or service-side handlers.
1414

15-
`LiquidityManager` uses an evening system to notify the user about important updates to the protocol flow. To this end, you will need to handle events emitted via one of the event handling methods provided by `LiquidityManager`, e.g., `LiquidityManager::wait_next_event`.
15+
`LiquidityManager` uses an evening system to notify the user about important updates to the protocol flow. To this end, you will need to handle events emitted via one of the event handling methods provided by `LiquidityManager`, e.g., `LiquidityManager::next_event`.
1616

1717
[LSP specifications]: https://github.com/BitcoinAndLightningLayerSpecs/lsp
1818
[LSPS0]: https://github.com/BitcoinAndLightningLayerSpecs/lsp/tree/main/LSPS0

lightning-liquidity/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@
2626
//!
2727
//! [`LiquidityManager`] uses an evening system to notify the user about important updates to the
2828
//! protocol flow. To this end, you will need to handle events emitted via one of the event
29-
//! handling methods provided by [`LiquidityManager`], e.g., [`LiquidityManager::wait_next_event`].
29+
//! handling methods provided by [`LiquidityManager`], e.g., [`LiquidityManager::next_event`].
3030
//!
3131
//! [LSP specifications]: https://github.com/BitcoinAndLightningLayerSpecs/lsp
3232
//! [LSPS0]: https://github.com/BitcoinAndLightningLayerSpecs/lsp/tree/main/LSPS0
3333
//! [LSPS1]: https://github.com/BitcoinAndLightningLayerSpecs/lsp/tree/main/LSPS1
3434
//! [LSPS2]: https://github.com/BitcoinAndLightningLayerSpecs/lsp/tree/main/LSPS2
3535
//! [`CustomMessageHandler`]: lightning::ln::peer_handler::CustomMessageHandler
36-
//! [`LiquidityManager::wait_next_event`]: crate::LiquidityManager::wait_next_event
36+
//! [`LiquidityManager::next_event`]: crate::LiquidityManager::next_event
3737
#![deny(missing_docs)]
3838
#![deny(rustdoc::broken_intra_doc_links)]
3939
#![deny(rustdoc::private_intra_doc_links)]

0 commit comments

Comments
 (0)