rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-06-16 14:17:34 +02:00
Code Issues Releases Activity

Add hash to rustdoc example (#1282)

Browse Source 
Hashes are important (and somewhat confusing to novices) part of the
rustdoc.
This commit is contained in:
Yuri Astrakhan
2023-10-02 08:23:46 -04:00
committed by GitHub
parent 1d658ead10
commit 36449cb1b2
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/testing/doc-tests.md
View File

@ -6,7 +6,7 @@ Rust has built-in support for documentation tests:
/// Shortens a string to the given length. /// Shortens a string to the given length.
/// ///
/// ``` /// ```
/// use playground::shorten_string; /// # use playground::shorten_string;
/// assert_eq!(shorten_string("Hello World", 5), "Hello"); /// assert_eq!(shorten_string("Hello World", 5), "Hello");
/// assert_eq!(shorten_string("Hello World", 20), "Hello World"); /// assert_eq!(shorten_string("Hello World", 20), "Hello World");
/// ``` /// ```
@ -17,4 +17,5 @@ pub fn shorten_string(s: &str, length: usize) -> &str {
* Code blocks in `///` comments are automatically seen as Rust code. * Code blocks in `///` comments are automatically seen as Rust code.
* The code will be compiled and executed as part of `cargo test`. * The code will be compiled and executed as part of `cargo test`.
* Adding `# ` in the code will hide it from the docs, but will still compile/run it.
* Test the above code on the [Rust Playground](https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=3ce2ad13ea1302f6572cb15cd96becf0). * Test the above code on the [Rust Playground](https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=3ce2ad13ea1302f6572cb15cd96becf0).