rust
/
reference
mirror of https://github.com/rust-lang/reference
1
0
Fork 0
Code Issues Releases Wiki Activity

STYLE.md: Fix typo.

This commit is contained in:
Benjamin Herr 2021-03-11 21:11:13 -08:00
parent 7bb13bfa8e
commit a1100f175f
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
STYLE.md
View File

@ -47,7 +47,7 @@ Rust examples are tested via rustdoc, and should include the appropriate annotat
* `compile_fail` — The example is expected to fail to compile.
* `ignore` — The example shouldn't be built or tested.
This should be avoided if possible.
Usually this is only necessary when the testing framework does not support it (such as external crates or modules, or a proc-macro), or it contains psuedo-code which is not valid Rust.
Usually this is only necessary when the testing framework does not support it (such as external crates or modules, or a proc-macro), or it contains pseudo-code which is not valid Rust.
An HTML comment such as `<!-- ignore: requires extern crate -->` should be placed before the example to explain why it is ignored.
See the [rustdoc documentation] for more detail.