summary refs log tree commit diff
path: root/compiler/rustc_errors
diff options
context:
space:
mode:
authorRyan Levick <me@ryanlevick.com>2021-07-06 13:47:03 +0200
committerRyan Levick <me@ryanlevick.com>2021-07-06 13:47:03 +0200
commit5af5a6d49dd5a72c7c4f48ba9749b84002e0b99e (patch)
treefdd5d5349f85ffcb27d1e9d5924ed02b41d5729f /compiler/rustc_errors
parent33cc7b1fe21c82d31204e549cd2471ac8ec22aa3 (diff)
downloadrust-5af5a6d49dd5a72c7c4f48ba9749b84002e0b99e.tar.gz
rust-5af5a6d49dd5a72c7c4f48ba9749b84002e0b99e.zip
Add missing docs and remove dead code
Diffstat (limited to 'compiler/rustc_errors')
-rw-r--r--compiler/rustc_errors/src/lib.rs12
1 files changed, 10 insertions, 2 deletions
diff --git a/compiler/rustc_errors/src/lib.rs b/compiler/rustc_errors/src/lib.rs
index a5e11541c8b..323415f3300 100644
--- a/compiler/rustc_errors/src/lib.rs
+++ b/compiler/rustc_errors/src/lib.rs
@@ -521,7 +521,8 @@ impl Handler {
     }
 
     /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
-    /// Cancel the builder if warnings cannot be emitted
+    ///
+    /// The builder will be canceled if warnings cannot be emitted.
     pub fn struct_span_warn(&self, span: impl Into<MultiSpan>, msg: &str) -> DiagnosticBuilder<'_> {
         let mut result = self.struct_warn(msg);
         result.set_span(span);
@@ -529,6 +530,9 @@ impl Handler {
     }
 
     /// Construct a builder at the `Warning` level at the given `span` and with the `msg`.
+    ///
+    /// This will "force" the warning meaning it will not be canceled even
+    /// if warnings cannot be emitted.
     pub fn struct_span_force_warn(
         &self,
         span: impl Into<MultiSpan>,
@@ -564,7 +568,8 @@ impl Handler {
     }
 
     /// Construct a builder at the `Warning` level with the `msg`.
-    /// Cancel the builder if warnings cannot be emitted
+    ///
+    /// The builder will be canceled if warnings cannot be emitted.
     pub fn struct_warn(&self, msg: &str) -> DiagnosticBuilder<'_> {
         let mut result = DiagnosticBuilder::new(self, Level::Warning, msg);
         if !self.flags.can_emit_warnings {
@@ -574,6 +579,9 @@ impl Handler {
     }
 
     /// Construct a builder at the `Warning` level with the `msg`.
+    ///
+    /// This will "force" a warning meaning it will not be canceled even
+    /// if warnings cannot be emitted.
     pub fn struct_force_warn(&self, msg: &str) -> DiagnosticBuilder<'_> {
         DiagnosticBuilder::new(self, Level::Warning, msg)
     }