Add warning if potentially-scrapable examples are skipped due to dev-dependencies#11503
Conversation
|
Sounds reasonable but not sure if it will become too verbose. Could we have a link to the original feedback as a reference? |
|
Sure, for instance here's a user whose examples weren't being scraped until they added this configuration: https://www.reddit.com/r/rust/comments/zosle6/feedback_requested_rustdocs_scraped_examples/j0qnmu5/ Right now users would only encounter this message if they enable scraping with |
weihanglo
left a comment
There was a problem hiding this comment.
Make sense. Thank you for posting this!
Just some style suggestions. Feel free to let me know by giving a thumb down to this comment. I'll then merge it as-is 👻
|
Just incorporated your suggestions @weihanglo. |
|
Thanks! @bors r+ |
|
☀️ Test successful - checks-actions |
7 commits in c994a4a638370bc7e0ffcbb0e2865afdfa7d4415..2381cbdb4e9b07090f552d34a44a529b6e620e44 2022-12-18 21:50:58 +0000 to 2022-12-23 12:19:27 +0000 - fix: deduplicate dependencies by artifact target (rust-lang/cargo#11478) - Add warning if potentially-scrapable examples are skipped due to dev-dependencies (rust-lang/cargo#11503) - Don't scrape examples from library targets by default (rust-lang/cargo#11499) - Stabilize terminal-width (rust-lang/cargo#11494) - Make sure that hash of `SourceId` is stable (rust-lang/cargo#11501) - Use workspace lockfile when running `cargo package` and `cargo publish` (rust-lang/cargo#11477) - Show `--help` if there is no man page for subcommand (rust-lang/cargo#11473)
Update cargo 7 commits in c994a4a638370bc7e0ffcbb0e2865afdfa7d4415..2381cbdb4e9b07090f552d34a44a529b6e620e44 2022-12-18 21:50:58 +0000 to 2022-12-23 12:19:27 +0000 - fix: deduplicate dependencies by artifact target (rust-lang/cargo#11478) - Add warning if potentially-scrapable examples are skipped due to dev-dependencies (rust-lang/cargo#11503) - Don't scrape examples from library targets by default (rust-lang/cargo#11499) - Stabilize terminal-width (rust-lang/cargo#11494) - Make sure that hash of `SourceId` is stable (rust-lang/cargo#11501) - Use workspace lockfile when running `cargo package` and `cargo publish` (rust-lang/cargo#11477) - Show `--help` if there is no man page for subcommand (rust-lang/cargo#11473) r? `@ghost`
What does this PR try to resolve?
Another point of feedback I've received on the scrape-examples feature is that the dev-dependency situation is quite confusing and subtle. To make users more aware of the issue, I added a warning where Cargo will alert users when examples are skipped due to a dev-dependency requirement, along with proposing a fix.
How should we test and review this PR?
The test
docscrape::no_scrape_with_dev_depshas been updated to reflect this new warning.r? @weihanglo
(PS thank you for the reviews Weihang. I know I'm doing lots of little patches right now to get this feature finalized. If you want to share the reviewing burden on scrape-examples with anyone else, let me know!)