about summary refs log tree commit diff
path: root/compiler/rustc_errors/src
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2023-01-06 21:26:09 +0100
committerGitHub <noreply@github.com>2023-01-06 21:26:09 +0100
commit7568c49bf0c11038635458cabb9661b6b4297d74 (patch)
tree00445f1fd865644b54f0969b5759ef0973d07a5a /compiler/rustc_errors/src
parentafe8c4537c9009a251a31e8f022b7795fc305d4f (diff)
parent0047e250909dd4739fcd20e77a49685f45490987 (diff)
downloadrust-7568c49bf0c11038635458cabb9661b6b4297d74.tar.gz
rust-7568c49bf0c11038635458cabb9661b6b4297d74.zip
Rollup merge of #106287 - Nilstrieb:its-bugging-me-how-we-dont-have-docs, r=jyn514
Add some docs to `bug`, `span_bug` and `delay_span_bug`

cc `@mejrs` as you wanted me to do this, does this look good and understandable?
Diffstat (limited to 'compiler/rustc_errors/src')
-rw-r--r--compiler/rustc_errors/src/lib.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/compiler/rustc_errors/src/lib.rs b/compiler/rustc_errors/src/lib.rs
index 136c360201e..621704335e4 100644
--- a/compiler/rustc_errors/src/lib.rs
+++ b/compiler/rustc_errors/src/lib.rs
@@ -978,6 +978,7 @@ impl Handler {
         self.inner.borrow_mut().span_bug(span, msg)
     }
 
+    /// For documentation on this, see `Session::delay_span_bug`.
     #[track_caller]
     pub fn delay_span_bug(
         &self,
@@ -1529,6 +1530,7 @@ impl HandlerInner {
         self.emit_diagnostic(diag.set_span(sp));
     }
 
+    /// For documentation on this, see `Session::delay_span_bug`.
     #[track_caller]
     fn delay_span_bug(
         &mut self,