A solution for empty main in lib.rs, I think!

The reasons we needed empty `fn main() {}`s were twofold:

- Avoid confusing people when they click the "expand" button on the code
listing and see the auto-main wrapping
- Avoid failing doctests when running `mdbook test` that don't work when
rustdoc wraps a code listing in main

I think I have a solution that mostly solves these cases.

I don't know why this didn't occur to me before. Here's my current
thinking in case these assumptions turn out to be wrong:

There are a [few things that tell mdbook to disable the
main-wrapping][mdbook], and I hadn't noticed one of them until now: if
you annotate a code block with `noplayground`, it won't add a `main`
around it (and it also won't have the "play" button in the upper right
that runs the block and inserts the result into the page).

So instead of putting an empty `fn main() {}` at the bottom of
src/lib.rs files that doesn't make sense, annotate those listings with
`noplayground`. I don't think anyone will miss the play button anyway
because:

- The play button doesn't run tests, so there wasn't any output for
these examples anyway
- If an example doesn't compile, we have it marked `ignore` so that it
doesn't make the tests fail, and `ignore` also disables the play button,
so there isn't a way to see compiler errors either

In most of these cases, `mdbook test` that runs these as doctests will
still wrap these in main, but the tests still pass.

There are some cases, mostly around modules and using `crate::` that
won't pass as doctests when wrapped in main. For those, I've annotated
them with the [undocumented][] [`test_harness`][] attribute that apparently
I was using at some point and then [stopped using][] and now I've
decided to use again, but maybe send in a PR to rust-lang/rust to
change the name to `no_main` and document it or something. In any case,
that shouldn't affect readers at all.

[mdbook]: https://github.com/rust-lang/mdBook/blob/d0deee90b04068ed949f524bb682a47fa26f2218/src/renderer/html_handlebars/hbs_renderer.rs#L805-L808
[undocumented]: rust-lang/rust#42288 (comment)
[`test_harness`]: https://github.com/rust-lang/rust/blob/220352781c2585f0efb07ab0e758b136514de5b8/src/librustdoc/doctest.rs#L252
[stopped using]: #1233 (comment)

ci/dictionary.txt

@@ -318,6 +318,7 @@ nonadministrators
 nondeterministic
 nonequality
 nongeneric
+noplayground
 NotFound
 nsprust
 null's
@@ -470,6 +471,7 @@ supertraits
 TcpListener
 TcpStream
 templating
+test_harness
 test's
 TextField
 That'd

listings/ch07-managing-growing-projects/listing-07-01/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 mod front_of_house {
     mod hosting {
         fn add_to_waitlist() {}
@@ -14,6 +13,3 @@ mod front_of_house {
         fn take_payment() {}
     }
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch07-managing-growing-projects/listing-07-07/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 mod front_of_house {
     pub mod hosting {
         pub fn add_to_waitlist() {}
@@ -12,6 +11,3 @@ pub fn eat_at_restaurant() {
     // Relative path
     front_of_house::hosting::add_to_waitlist();
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch07-managing-growing-projects/listing-07-08/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 fn serve_order() {}
 
 mod back_of_house {
@@ -9,6 +8,3 @@ mod back_of_house {
 
     fn cook_order() {}
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch07-managing-growing-projects/listing-07-11/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 mod front_of_house {
     pub mod hosting {
         pub fn add_to_waitlist() {}
@@ -12,6 +11,3 @@ pub fn eat_at_restaurant() {
     hosting::add_to_waitlist();
     hosting::add_to_waitlist();
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch07-managing-growing-projects/listing-07-12/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 mod front_of_house {
     pub mod hosting {
         pub fn add_to_waitlist() {}
@@ -12,6 +11,3 @@ pub fn eat_at_restaurant() {
     hosting::add_to_waitlist();
     hosting::add_to_waitlist();
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch07-managing-growing-projects/listing-07-13/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 mod front_of_house {
     pub mod hosting {
         pub fn add_to_waitlist() {}
@@ -12,6 +11,3 @@ pub fn eat_at_restaurant() {
     add_to_waitlist();
     add_to_waitlist();
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch07-managing-growing-projects/listing-07-17/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 mod front_of_house {
     pub mod hosting {
         pub fn add_to_waitlist() {}
@@ -12,6 +11,3 @@ pub fn eat_at_restaurant() {
     hosting::add_to_waitlist();
     hosting::add_to_waitlist();
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/listing-11-01/src/lib.rs

@@ -1,11 +1,7 @@
-// ANCHOR: here
 #[cfg(test)]
 mod tests {
     #[test]
     fn it_works() {
         assert_eq!(2 + 2, 4);
     }
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/listing-11-03/src/lib.rs

@@ -12,5 +12,3 @@ mod tests {
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/listing-11-05/src/lib.rs

@@ -11,5 +11,3 @@ impl Rectangle {
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/listing-11-06/src/lib.rs

@@ -30,5 +30,3 @@ mod tests {
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/listing-11-07/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 pub fn add_two(a: i32) -> i32 {
     a + 2
 }
@@ -12,6 +11,3 @@ mod tests {
         assert_eq!(4, add_two(2));
     }
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/listing-11-08/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 pub struct Guess {
     value: i32,
 }
@@ -23,6 +22,3 @@ mod tests {
         Guess::new(200);
     }
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/listing-11-09/src/lib.rs

@@ -33,5 +33,3 @@ mod tests {
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/listing-11-10/src/lib.rs

@@ -1,6 +1,3 @@
-fn main() {}
-
-// ANCHOR: here
 fn prints_and_returns_10(a: i32) -> i32 {
     println!("I got the value {}", a);
     10
@@ -22,4 +19,3 @@ mod tests {
         assert_eq!(5, value);
     }
 }
-// ANCHOR_END: here

listings/ch11-writing-automated-tests/listing-11-12/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 pub fn add_two(a: i32) -> i32 {
     internal_adder(a, 2)
 }
@@ -16,6 +15,3 @@ mod tests {
         assert_eq!(4, internal_adder(2, 2));
     }
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/no-listing-01-changing-test-name/src/lib.rs

@@ -1,11 +1,7 @@
-// ANCHOR: here
 #[cfg(test)]
 mod tests {
     #[test]
     fn exploration() {
         assert_eq!(2 + 2, 4);
     }
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/no-listing-02-adding-another-rectangle-test/src/lib.rs

@@ -47,5 +47,3 @@ mod tests {
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/no-listing-03-introducing-a-bug/src/lib.rs

@@ -45,5 +45,3 @@ mod tests {
         assert!(!smaller.can_hold(&larger));
     }
 }
-
-fn main() {}

listings/ch11-writing-automated-tests/no-listing-04-bug-in-add-two/src/lib.rs

@@ -13,5 +13,3 @@ mod tests {
         assert_eq!(4, add_two(2));
     }
 }
-
-fn main() {}

listings/ch11-writing-automated-tests/no-listing-05-greeter/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 pub fn greeting(name: &str) -> String {
     format!("Hello {}!", name)
 }
@@ -13,6 +12,3 @@ mod tests {
         assert!(result.contains("Carol"));
     }
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/no-listing-06-greeter-with-bug/src/lib.rs

@@ -14,5 +14,3 @@ mod tests {
         assert!(result.contains("Carol"));
     }
 }
-
-fn main() {}

listings/ch11-writing-automated-tests/no-listing-08-guess-with-bug/src/lib.rs

@@ -25,5 +25,3 @@ mod tests {
         Guess::new(200);
     }
 }
-
-fn main() {}

listings/ch11-writing-automated-tests/no-listing-10-result-in-tests/src/lib.rs

@@ -1,7 +1,3 @@
-#![allow(unused_variables)]
-fn main() {}
-
-// ANCHOR: here
 #[cfg(test)]
 mod tests {
     #[test]
@@ -13,4 +9,3 @@ mod tests {
         }
     }
 }
-// ANCHOR_END: here

listings/ch11-writing-automated-tests/no-listing-11-ignore-a-test/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 #[test]
 fn it_works() {
     assert_eq!(2 + 2, 4);
@@ -9,6 +8,3 @@ fn it_works() {
 fn expensive_test() {
     // code that takes an hour to run
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch11-writing-automated-tests/output-only-04-running-ignored/src/lib.rs

@@ -10,5 +10,3 @@ fn expensive_test() {
     // code that takes an hour to run
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch12-an-io-project/listing-12-15/src/lib.rs

@@ -42,5 +42,3 @@ Pick three.";
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch12-an-io-project/listing-12-16/src/lib.rs

@@ -46,5 +46,3 @@ Pick three.";
         assert_eq!(vec!["safe, fast, productive."], search(query, contents));
     }
 }
-
-fn main() {}

listings/ch12-an-io-project/listing-12-20/src/lib.rs

@@ -74,5 +74,3 @@ Trust me.";
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch12-an-io-project/listing-12-21/src/lib.rs

@@ -90,5 +90,3 @@ Trust me.";
         );
     }
 }
-
-fn main() {}

listings/ch12-an-io-project/listing-12-22/src/lib.rs

@@ -99,5 +99,3 @@ Trust me.";
         );
     }
 }
-
-fn main() {}

listings/ch12-an-io-project/listing-12-23/src/lib.rs

@@ -108,5 +108,3 @@ Trust me.";
         );
     }
 }
-
-fn main() {}

listings/ch12-an-io-project/output-only-02-missing-lifetimes/src/lib.rs

@@ -46,5 +46,3 @@ Pick three.";
         assert_eq!(vec!["safe, fast, productive."], search(query, contents));
     }
 }
-
-fn main() {}

listings/ch13-functional-features/listing-12-23-reproduced/src/lib.rs

@@ -104,5 +104,3 @@ Trust me.";
         );
     }
 }
-
-fn main() {}

listings/ch13-functional-features/listing-13-15/src/lib.rs

@@ -14,5 +14,3 @@ mod tests {
     }
     // ANCHOR_END: here
 }
-
-fn main() {}

listings/ch13-functional-features/listing-13-16/src/lib.rs

@@ -13,5 +13,3 @@ mod tests {
     }
     // ANCHOR_END: here
 }
-
-fn main() {}

listings/ch13-functional-features/listing-13-19/src/lib.rs

@@ -46,5 +46,3 @@ mod tests {
         );
     }
 }
-
-fn main() {}

listings/ch13-functional-features/listing-13-20/src/lib.rs

@@ -7,5 +7,3 @@ impl Counter {
         Counter { count: 0 }
     }
 }
-
-fn main() {}

listings/ch13-functional-features/listing-13-21/src/lib.rs

@@ -22,5 +22,3 @@ impl Iterator for Counter {
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch13-functional-features/listing-13-22/src/lib.rs

@@ -39,5 +39,3 @@ mod tests {
     }
     // ANCHOR_END: here
 }
-
-fn main() {}

listings/ch13-functional-features/listing-13-23/src/lib.rs

@@ -49,5 +49,3 @@ mod tests {
     }
     // ANCHOR_END: here
 }
-
-fn main() {}

listings/ch13-functional-features/listing-13-27/src/lib.rs

@@ -109,5 +109,3 @@ Trust me.";
         );
     }
 }
-
-fn main() {}

listings/ch14-more-about-cargo/listing-14-03/src/lib.rs

@@ -1,4 +1,3 @@
-// ANCHOR: here
 //! # Art
 //!
 //! A library for modeling artistic concepts.
@@ -31,6 +30,3 @@ pub mod utils {
         // ANCHOR: here
     }
 }
-// ANCHOR_END: here
-
-fn main() {}

listings/ch15-smart-pointers/listing-15-22/src/lib.rs

@@ -76,5 +76,3 @@ mod tests {
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch17-oop/listing-17-07/src/lib.rs

@@ -27,5 +27,3 @@ impl Draw for Button {
     }
 }
 // ANCHOR_END: here
-
-fn main() {}

listings/ch17-oop/listing-17-13/src/lib.rs

@@ -26,5 +26,3 @@ trait State {}
 struct Draft {}
 
 impl State for Draft {}
-
-fn main() {}