about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorAdam Perry <lol@anp.lol>2020-07-19 11:36:24 -0700
committerGitHub <noreply@github.com>2020-07-19 11:36:24 -0700
commit416dc4b978e5921cd0b20478a17f048dd378bdff (patch)
treea9b51b1cdc9ac316ae446bc82e4bf72973837689 /src
parentd275739c09f266479d6db388cbf55ba6ca791b9d (diff)
downloadrust-416dc4b978e5921cd0b20478a17f048dd378bdff.tar.gz
rust-416dc4b978e5921cd0b20478a17f048dd378bdff.zip
Clarify core::panic::Location's docs on ordering.
Co-authored-by: Simon Sapin <simon.sapin@exyr.org>
Diffstat (limited to 'src')
-rw-r--r--src/libcore/panic.rs6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/libcore/panic.rs b/src/libcore/panic.rs
index aa3625ac019..94181084dbc 100644
--- a/src/libcore/panic.rs
+++ b/src/libcore/panic.rs
@@ -176,9 +176,9 @@ impl fmt::Display for PanicInfo<'_> {
 ///
 /// # Comparisons
 ///
-/// Comparisons for equality and ordering are made in file, line, then column priority. Such
-/// comparisons can occasionally have surprising results. See [`Location::file`]'s documentation for
-/// more discussion.
+/// Comparisons for equality and ordering are made in file, line, then column priority.
+/// Files are compared as strings, not `Path`, which could be unexpected.
+/// See [`Location::file`]'s documentation for more discussion.
 #[lang = "panic_location"]
 #[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
 #[stable(feature = "panic_hooks", since = "1.10.0")]