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 indoc'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 Jan 3, 2023
1 parent 89e4d0e commit 3b01aa9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ rust-version = "1.42"

[lib]
proc-macro = true
doc-scrape-examples = false

[dev-dependencies]
rustversion = "1.0"
Expand Down
3 changes: 3 additions & 0 deletions unindent/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,8 @@ keywords = ["heredoc", "nowdoc", "multiline", "string", "literal"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/dtolnay/indoc"

[lib]
doc-scrape-examples = false

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]

0 comments on commit 3b01aa9

Please sign in to comment.