Skip to content

Commit c16e53a

Browse files
authored
Update 0000-rustdoc-scrape-examples.md
1 parent 04384c0 commit c16e53a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

text/0000-rustdoc-scrape-examples.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The goal of this RFC is to bridge the gap between automatically generated docume
5454
The `scrape-examples` feature of Rustdoc finds examples of code where a particular function is called. For example, if we are documenting [`Filter::and`](https://willcrichton.net/example-analyzer/warp/trait.Filter.html#method.and), and a file [`examples/returning.rs`](https://github.com/seanmonstar/warp/tree/bf8bfc4134035dbff882f9b26cb9d1aa57f2c338/examples/returning.rs) contains a call to `and`, then the corresponding Rustdoc documentation looks like this:
5555

5656
<kbd>
57-
<img width="1010" alt="Screen Shot 2021-05-09 at 8 07 52 PM" src="https://user-images.githubusercontent.com/663326/117593843-69eb2080-b102-11eb-8319-ec07e05a17f0.png">
57+
<img width="982" alt="Screen Shot 2021-05-11 at 11 31 12 AM" src="https://user-images.githubusercontent.com/663326/117852001-81cebb80-b24c-11eb-88ef-8532a5f012c4.png">
5858
</kbd>
5959
<br /><br />
6060

@@ -63,7 +63,8 @@ After the user-provided documentation in the doc-comment, `scrape-examples` inse
6363
Additionally, the user can click "More examples" to see every example from the `examples/` directory, like this:
6464

6565
<kbd>
66-
<img width="975" alt="Screen Shot 2021-05-09 at 8 16 09 PM" src="https://user-images.githubusercontent.com/663326/117594318-7cb22500-b103-11eb-9a24-5dc11d67558c.png">
66+
<img width="956" alt="Screen Shot 2021-05-11 at 11 31 36 AM" src="https://user-images.githubusercontent.com/663326/117852026-8abf8d00-b24c-11eb-819d-51627798e005.png">
67+
6768
</kbd>
6869
<br /><br />
6970

0 commit comments

Comments
 (0)