Document new field and function

1 files changed, 5 insertions, 0 deletions

diff --git a/compiler/rustc_errors/src/lib.rs b/compiler/rustc_errors/src/lib.rs
index 242684e63a0..2086d4030f9 100644
--- a/compiler/rustc_errors/src/lib.rs
+++ b/compiler/rustc_errors/src/lib.rs
@@ -418,6 +418,8 @@ pub struct DiagCtxt {
 #[derive(Copy, Clone)]
 pub struct DiagCtxtHandle<'a> {
     dcx: &'a DiagCtxt,
+    /// Some contexts create `DiagCtxtHandle` with this field set, and thus all
+    /// errors emitted with it will automatically taint when emitting errors.
     tainted_with_errors: Option<&'a Cell<Option<ErrorGuaranteed>>>,
 }
 
@@ -757,6 +759,9 @@ impl DiagCtxt {
         DiagCtxtHandle { dcx: self, tainted_with_errors: None }
     }
 
+    /// Link this to a taintable context so that emitting errors will automatically set
+    /// the `Option<ErrorGuaranteed>` instead of having to do that manually at every error
+    /// emission site.
     pub fn taintable_handle<'a>(
         &'a self,
         tainted_with_errors: &'a Cell<Option<ErrorGuaranteed>>,