about summary refs log tree commit diff
path: root/compiler/rustc_hir/src/def.rs
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2025-07-25 17:27:08 -0700
committerJosh Triplett <josh@joshtriplett.org>2025-07-25 22:01:49 -0700
commit3352dfc4a232fa6f38db3ea3ed465f56e6c8f85b (patch)
treefd60afeed637238e63c2e9e3919f46fc79df814b /compiler/rustc_hir/src/def.rs
parent29a58723b05d004c2e19ddcf2be80d514401f22e (diff)
downloadrust-3352dfc4a232fa6f38db3ea3ed465f56e6c8f85b.tar.gz
rust-3352dfc4a232fa6f38db3ea3ed465f56e6c8f85b.zip
Skip formatting for some compiler documentation code
These examples feature Rust code that's presented primarily to
illustrate how its compilation would be handled, and these examples are
formatted to highlight those aspects in ways that rustfmt wouldn't
preserve. Turn formatting off in those examples.

(Doc code isn't formatted yet, but this will make it easier to enable
doc code formatting in the future.)
Diffstat (limited to 'compiler/rustc_hir/src/def.rs')
-rw-r--r--compiler/rustc_hir/src/def.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/compiler/rustc_hir/src/def.rs b/compiler/rustc_hir/src/def.rs
index ca57c4f3164..5024c85e2a8 100644
--- a/compiler/rustc_hir/src/def.rs
+++ b/compiler/rustc_hir/src/def.rs
@@ -356,7 +356,7 @@ impl DefKind {
 /// For example, everything prefixed with `/* Res */` in this example has
 /// an associated `Res`:
 ///
-/// ```
+/// ```ignore (illustrative)
 /// fn str_to_string(s: & /* Res */ str) -> /* Res */ String {
 ///     /* Res */ String::from(/* Res */ s)
 /// }