Skip to content

Commit c8ddf36

Browse files
committed
Fix new rustc #[macro_export] warning in doctests
rustc now warns any time a `#[macro_export]` is used inside a function as it generates surprising results. Because doctests are run inside implicit test functions this means any use of `#[macro_export]` inside a doctest will now warn. We do this in `lightning-custom-message` to demonstrated how to use the crate, which now fails to compile. Here we fix this by adding an `fn main() {}` to the doctest, which causes doctests to be compiled as freestanding code rather than inside a test function. Note that while discussing this upstream it came up that rustc is also planning on changing the way doctests are compiled to compile an entire crate's doctests in one go rather than in separate crates, causing doctests to have a shared namespace which may generate future surprising outcomes.
1 parent 2b14cc4 commit c8ddf36

File tree

1 file changed

+1
-2
lines changed
  • lightning-custom-message/src

1 file changed

+1
-2
lines changed

lightning-custom-message/src/lib.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
//! `Foo` and `Bar` messages, and further composing it with a handler for `Baz` messages.
1313
//!
1414
//!```
15+
//! # fn main() {} // Avoid #[macro_export] generating an in-function warning
1516
//! # extern crate bitcoin;
1617
//! extern crate lightning;
1718
//! #[macro_use]
@@ -167,7 +168,6 @@
167168
//! # }
168169
//! }
169170
//!
170-
//! # fn main() {
171171
//! // The first crate may define a handler composing `FooHandler` and `BarHandler` and export the
172172
//! // corresponding message type ids as a macro to use in further composition.
173173
//!
@@ -207,7 +207,6 @@
207207
//! macro_rules! foo_bar_baz_type_ids {
208208
//! () => { foo_bar_type_ids!() | baz_type_id!() }
209209
//! }
210-
//! # }
211210
//!```
212211
//!
213212
//! [BOLT 1]: https://github.com/lightning/bolts/blob/master/01-messaging.md

0 commit comments

Comments
 (0)