Improve failed scrape diagnostic

Author: willcrichton

src/cargo/core/compiler/mod.rs

@@ -224,7 +224,7 @@ fn make_failed_scrape_diagnostic(
         "\
 {top_line}
     Try running with `--verbose` to see the error message.
-    If an example or library should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` or `[lib]` definition in {}",
+    If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in {}",
         relative_manifest_path.display()
     )
 }

src/cargo/ops/cargo_compile/unit_generator.rs

@@ -680,8 +680,10 @@ impl<'a> UnitGenerator<'a, '_> {
 
     /// Generates units specfically for doc-scraping.
     ///
-    /// This requires a separate entrypoint from `generate_root_units` because it
+    /// This requires a separate entrypoint from [`generate_root_units`] because it
     /// takes the documented units as input.
+    ///
+    /// [`generate_root_units`]: Self::generate_root_units
     pub fn generate_scrape_units(&self, doc_units: &[Unit]) -> CargoResult<Vec<Unit>> {
         let scrape_proposals = self.create_docscrape_proposals(&doc_units)?;
         let scrape_units = self.proposals_to_units(scrape_proposals)?;

tests/testsuite/docscrape.rs

@@ -350,15 +350,15 @@ fn no_fail_bad_lib() {
 [SCRAPING] foo v0.0.1 ([CWD])
 warning: failed to check lib in package `foo` as a prerequisite for scraping examples from: example \"ex\", example \"ex2\"
     Try running with `--verbose` to see the error message.
-    If an example or library should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` or `[lib]` definition in Cargo.toml
+    If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
 warning: `foo` (lib) generated 1 warning
 warning: failed to scan example \"ex\" in package `foo` for example code usage
     Try running with `--verbose` to see the error message.
-    If an example or library should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` or `[lib]` definition in Cargo.toml
+    If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
 warning: `foo` (example \"ex\") generated 1 warning
 warning: failed to scan example \"ex2\" in package `foo` for example code usage
     Try running with `--verbose` to see the error message.
-    If an example or library should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` or `[lib]` definition in Cargo.toml
+    If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
 warning: `foo` (example \"ex2\") generated 1 warning
 [DOCUMENTING] foo v0.0.1 ([CWD])
 [FINISHED] dev [unoptimized + debuginfo] target(s) in [..]",
@@ -391,7 +391,7 @@ fn no_fail_bad_example() {
 [SCRAPING] foo v0.0.1 ([CWD])
 warning: failed to scan example \"ex1\" in package `foo` for example code usage
     Try running with `--verbose` to see the error message.
-    If an example or library should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` or `[lib]` definition in Cargo.toml
+    If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
 warning: `foo` (example \"ex1\") generated 1 warning
 [DOCUMENTING] foo v0.0.1 ([CWD])
 [FINISHED] dev [unoptimized + debuginfo] target(s) in [..]",