Skip to content

Commit

Permalink
Opt out -Zrustdoc-scrape-examples on docs.rs
Browse files Browse the repository at this point in the history
I'd like a chance to audit all the code that rustdoc is inserting into
the docs. Currently I am skeptical that showing anyhow's internal usages
of APIs is a net benefit to the public documentation. I am also
skeptical that quite so many examples are needed, and that they should
be featured so prominently in comparison to handwritten docs. Lastly I
wish there were a way to turn this behavior off on a more granular
basis.
  • Loading branch information
dtolnay committed Dec 18, 2022
1 parent 1cc707b commit c0a87d0
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ syn = { version = "1.0", features = ["full"] }
thiserror = "1.0"
trybuild = { version = "1.0.66", features = ["diff"] }

[lib]
doc-scrape-examples = false

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
rustdoc-args = ["--cfg", "doc_cfg"]

0 comments on commit c0a87d0

Please sign in to comment.