rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-15 06:20:32 +02:00
Code Issues Releases Activity

Add note about doc tests (#991)

Browse Source
This commit is contained in:
Dominik Maier 2023-07-17 23:16:23 +02:00 committed by GitHub
parent 4fe28011a0
commit ba403016b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/basic-syntax/rustdoc.md
View File

@ -30,4 +30,7 @@ idiomatic to document all public items in an API using this pattern.
* Inner doc comments are discussed later (in the page on modules) and need not
be addressed here.
* Rustdoc comments can contain code snippets that we can run and test using `cargo test`.
We will discuss these tests in the [Testing section](../testing/doc-tests.html).
</details>