rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-14 14:10:05 +02:00
Code Issues Releases Activity

Add unittest example to rustdoc (#1276)

Browse Source 
Fixes #1275

---------

Co-authored-by: Martin Geisler <martin@geisler.net>
This commit is contained in:
Yuri Astrakhan 2023-09-29 02:40:24 -04:00 committed by GitHub
parent 1c43db108b
commit c894ea3517
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -6,6 +6,11 @@ All language items in Rust can be documented using special `///` syntax.
/// Determine whether the first argument is divisible by the second argument.
///
/// If the second argument is zero, the result is false.
///
/// # Example
/// ```
/// assert!(is_divisible_by(42, 2));
/// ```
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
if rhs == 0 {
return false; // Corner case, early return
@ -18,6 +23,7 @@ The contents are treated as Markdown. All published Rust library crates are
automatically documented at [`docs.rs`](https://docs.rs) using the
[rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) tool. It is
idiomatic to document all public items in an API using this pattern.
Code snippets can document usage and will be used as unit tests.
<details>