Skip to content

Commit

Permalink
Clarify that scrape examples is unstable
Browse files Browse the repository at this point in the history
  • Loading branch information
willcrichton committed Mar 28, 2022
1 parent bb3ed6f commit 318e457
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/doc/rustdoc/src/scraped-examples.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scraped examples

Rustdoc can automatically scrape examples of items being documented from the `examples/` directory of a Cargo workspace. These examples will be included within the generated documentation for that item. For example, if your library contains a public function:
Rustdoc has an unstable feature where it can automatically scrape examples of items being documented from the `examples/` directory of a Cargo workspace. These examples will be included within the generated documentation for that item. For example, if your library contains a public function:

```rust,ignore (needs-other-file)
// a_crate/src/lib.rs
Expand Down

0 comments on commit 318e457

Please sign in to comment.