f - fixup docs

Author: jkczyz

lightning-custom-message/src/lib.rs

@@ -5,8 +5,8 @@
 //! defining such a handler requires a significant amount of boilerplate and can be error prone.
 //!
 //! This crate provides the [`composite_custom_message_handler`] macro for easily composing
-//! pre-defined custom message handlers. The resulting handler can be further composed with other
-//! custom message handlers using the same macro.
+//! pre-defined custom message handlers into one handler. The resulting handler can be further
+//! composed with other custom message handlers using the same macro.
 //!
 //! The following example demonstrates defining a `FooBarHandler` to compose separate handlers for
 //! `Foo` and `Bar` messages, and further composing it with a handler for `Baz` messages.
@@ -25,6 +25,9 @@
 //! use lightning::util::ser::Writeable;
 //! # use lightning::util::ser::Writer;
 //!
+//! // Assume that `FooHandler` and `BarHandler` are defined in one crate and `BazHandler` is
+//! // defined in another crate, handling messages `Foo`, `Bar`, and `Baz`, respectively.
+//!
 //! #[derive(Debug)]
 //! pub struct Foo;
 //!
@@ -146,6 +149,9 @@
 //! }
 //!
 //! # fn main() {
+//! // The first crate may define a handler composing `FooHandler` and `BarHandler` and export the
+//! // corresponding message type ids as a macro to use in further composition.
+//!
 //! composite_custom_message_handler!(
 //!     pub struct FooBarHandler {
 //!         foo: FooHandler,
@@ -158,10 +164,14 @@
 //!     }
 //! );
 //!
+//! #[macro_export]
 //! macro_rules! foo_bar_type_ids {
 //!     () => { foo_type_id!() | bar_type_id!() }
 //! }
 //!
+//! // Another crate can then define a handler further composing `FooBarHandler` with `BazHandler`
+//! // and similarly export the composition of message type ids as a macro.
+//!
 //! composite_custom_message_handler!(
 //!     pub struct FooBarBazHandler {
 //!         foo_bar: FooBarHandler,
@@ -173,6 +183,11 @@
 //!         Baz(baz_type_id!()),
 //!     }
 //! );
+//!
+//! #[macro_export]
+//! macro_rules! foo_bar_baz_type_ids {
+//!     () => { foo_bar_type_ids!() | baz_type_id!() }
+//! }
 //! # }
 //!```
 //!