]> git.lizzy.rs Git - rust.git/commitdiff
Update docs for Diagnostic::span_suggestion(s)
authorOliver Schneider <oli-obk@users.noreply.github.com>
Tue, 24 Oct 2017 11:08:30 +0000 (13:08 +0200)
committerGitHub <noreply@github.com>
Tue, 24 Oct 2017 11:08:30 +0000 (13:08 +0200)
src/librustc_errors/diagnostic.rs

index 02c0307e98cc8c0a8a0728212221a09bae710c12..f560622c2975d0c1e882f03942ae5a20a400a746 100644 (file)
@@ -229,6 +229,7 @@ pub fn span_suggestion_short(&mut self, sp: Span, msg: &str, suggestion: String)
     /// "try adding parentheses: `(tup.0).1`"
     ///
     /// The message
+    ///
     /// * should not end in any punctuation (a `:` is added automatically)
     /// * should not be a question
     /// * should not contain any parts like "the following", "as shown"
@@ -248,6 +249,7 @@ pub fn span_suggestion(&mut self, sp: Span, msg: &str, suggestion: String) -> &m
         self
     }
 
+    /// Prints out a message with multiple suggested edits of the code.
     pub fn span_suggestions(&mut self, sp: Span, msg: &str, suggestions: Vec<String>) -> &mut Self {
         self.suggestions.push(CodeSuggestion {
             substitution_parts: vec![Substitution {