Rename variable name

Author: dduan

Sources/Critic/DocProblem.swift

@@ -29,8 +29,7 @@ public struct DocProblem {
         case verticalAlignment(Int, String, Int) // Expected, name/keyword, line number
         case spaceAfterColon(String, String) // Keyword, actual
         case keywordCasingForParameter(String, String, String) // Actual, expected, name
-        // TODO: it's also about spelling of the keywords
-        case keywordCasing(String, String) // Actual, expected
+        case keywordSpelling(String, String) // Actual, expected
         case descriptionShouldEndWithEmptyLine
         case sectionShouldEndWithEmptyLine(String) // keyword or parameter name
         case redundantKeyword(String) // keyword
@@ -64,7 +63,7 @@ public struct DocProblem {
                 return "E009"
             case .spaceAfterColon:
                 return "E010"
-            case .keywordCasingForParameter, .keywordCasing:
+            case .keywordCasingForParameter, .keywordSpelling:
                 return "E011"
             case .descriptionShouldEndWithEmptyLine, .sectionShouldEndWithEmptyLine:
                 return "E012"

Sources/Critic/Validating.swift

@@ -122,7 +122,7 @@ func findReturnsProblems(
 
     if let keyword = returnsDoc.keyword?.text {
         if keyword != expectedKeyword {
-            result.append((.init(lineNumber, column), .keywordCasing(keyword, expectedKeyword)))
+            result.append((.init(lineNumber, column), .keywordSpelling(keyword, expectedKeyword)))
         }
 
         column += keyword.count
@@ -206,7 +206,7 @@ func findThrowsProblems(
     let expectedKeyword = firstLetterUpper ? "Throws" : "throws"
     if let keyword = throwsDoc.keyword?.text {
         if keyword != expectedKeyword {
-            result.append((.init(lineNumber, column), .keywordCasing(keyword, expectedKeyword)))
+            result.append((.init(lineNumber, column), .keywordSpelling(keyword, expectedKeyword)))
         }
 
         column += keyword.count
@@ -290,7 +290,7 @@ func findParameterProblems(fallback: RelativeLocation, _ line: Int, _ parameters
 
         let expectedKeyword = firstLetterUpper ? "Parameters" : "parameters"
         if keyword.text != expectedKeyword {
-            result.append((.init(lineNumber, column), .keywordCasing(keyword.text, expectedKeyword)))
+            result.append((.init(lineNumber, column), .keywordSpelling(keyword.text, expectedKeyword)))
         }
 
         column += keyword.text.count

Sources/Informant/PlainTextFormatter.swift

@@ -34,7 +34,7 @@ private extension DocProblem.Detail {
             return "For `\(keyword)`, there should be exactly 1 space after `:`, found \(actualWhitespace(actual))"
         case .keywordCasingForParameter(let actual, let expected, let name):
             return "For `\(name)`, `\(expected)` is misspelled as `\(actual)`"
-        case .keywordCasing(let actual, let expected):
+        case .keywordSpelling(let actual, let expected):
             return "`\(expected)` is misspelled as `\(actual)`"
         case .descriptionShouldEndWithEmptyLine:
             return "Overall description should end with an empty line"

Sources/Informant/TtyTextFormatter.swift

@@ -35,7 +35,7 @@ private extension DocProblem.Detail {
             return "For \(keyword, color: .green), there should be exactly 1 space after \(":", color: .green), found \(actualWhitespace(actual))"
         case .keywordCasingForParameter(let actual, let expected, let name):
             return "For \(name, color: .green), \(expected, color: .green) is misspelled as \(actual, color: .cyan)"
-        case .keywordCasing(let actual, let expected):
+        case .keywordSpelling(let actual, let expected):
             return "\(expected, color: .green) is misspelled as \(actual, color: .cyan)"
         case .descriptionShouldEndWithEmptyLine:
             return "Overall description should end with an empty line"