From 550f579816834642522310b2e4e54027b1d72972 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Sun, 9 Oct 2022 22:49:23 +0200 Subject: [PATCH] Add missing documentation for FileNameDisplayPreference variants --- compiler/rustc_span/src/lib.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/compiler/rustc_span/src/lib.rs b/compiler/rustc_span/src/lib.rs index f8df416971593..91eef647713db 100644 --- a/compiler/rustc_span/src/lib.rs +++ b/compiler/rustc_span/src/lib.rs @@ -298,7 +298,11 @@ impl From for FileName { #[derive(Clone, Copy, Eq, PartialEq, Hash, Debug)] pub enum FileNameDisplayPreference { + /// Display the path after the application of rewrite rules provided via `--remap-path-prefix`. + /// This is appropriate for paths that get embedded into files produced by the compiler. Remapped, + /// Display the path before the application of rewrite rules provided via `--remap-path-prefix`. + /// This is appropriate for use in user-facing output (such as diagnostics). Local, }