11---
22# 9qw-72x
33title : ' Improve rule summaries: fill empty static let summary fields'
4- status : ready
4+ status : completed
55type : task
66priority : normal
77created_at : 2026-04-11T18:22:20Z
8- updated_at : 2026-04-11T18:22 :20Z
8+ updated_at : 2026-04-11T18:55 :20Z
99sync :
1010 github :
1111 issue_number : " 181"
12- synced_at : " 2026-04-11T18:44:01Z "
12+ synced_at : " 2026-04-11T19:12:32Z "
1313---
1414
15156+ rules have ` static let summary = "" ` . Fill them in with concise, useful descriptions.
@@ -25,6 +25,42 @@ Identified rules with empty summaries:
2525
2626## Tasks
2727
28- - [ ] Find all rules with empty summary fields
29- - [ ] Write concise summaries for each
30- - [ ] Verify build passes
28+ - [x] Find all rules with empty summary fields (found 16)
29+ - [x] Write concise summaries for each
30+ - [x] Verify build passes
31+
32+
33+ ## Summary of Changes
34+
35+ Filled in 16 empty rule summaries and improved 9 existing ones that were vague or awkwardly phrased.
36+
37+ ### 16 new summaries
38+ - ` number_separator ` — Underscores should be used as thousand separators in large decimal numbers
39+ - ` unhandled_throwing_task ` — Errors thrown inside a Task are silently lost unless the result is checked
40+ - ` non_overridable_class_declaration ` — Use ` static ` or ` final ` instead of ` class ` for non-overridable members
41+ - ` superfluous_disable_command ` — Disable commands for rules that didn't trigger a violation are superfluous
42+ - ` blanket_disable_command ` — Disable commands should be scoped with ` next ` , ` this ` , or ` previous ` instead of the whole file
43+ - ` static_over_final_class ` — Prefer ` static ` over ` final class ` or ` class ` in a final class
44+ - ` shorthand_argument ` — Shorthand closure arguments (` $0 ` , ` $1 ` ) should be used sparingly and close to the closure opening
45+ - ` inclusive_language ` — Identifiers should use inclusive language that avoids discrimination
46+ - ` unused_parameter ` — Unused function parameters should be removed or replaced with ` _ `
47+ - ` type_name ` — Type names should be alphanumeric, start uppercase, and have a reasonable length
48+ - ` contrasted_opening_brace ` — Opening braces should be on a separate line from the preceding declaration
49+ - ` opening_brace ` — Opening braces should be preceded by a single space and on the same line as the declaration
50+ - ` switch_case_alignment ` — Case statements should vertically align with their enclosing switch's closing brace
51+ - ` colon ` — Colons should have no space before and one space after
52+ - ` attribute_name_spacing ` — There should be no space between an attribute or modifier and its arguments
53+ - ` attributes ` — Attributes should be on their own line for functions and types, same line for variables and imports
54+
55+ ### 9 improved summaries
56+ - ` invalid_command ` — was "sm: command is invalid"
57+ - ` unused_setter_value ` — was "Setter value is not used"
58+ - ` joined_default_parameter ` — was "Discouraged explicit usage of the default separator"
59+ - ` file_types_order ` — was "Specifies how the types within a file should be ordered."
60+ - ` type_contents_order ` — was "Specifies the order of subtypes, properties, methods & more within a type."
61+ - ` xct_specific_matcher ` — was "Prefer specific XCTest matchers."
62+ - ` discouraged_direct_init ` — was "Discouraged direct initialization of types that can be harmful"
63+ - ` syntactic_sugar ` — was "Shorthand syntactic sugar should be used, i.e. [ Int] instead of Array<Int >."
64+ - ` self_binding ` — was "Re-bind ` self ` to a consistent identifier name."
65+
66+ Confirmed: ` summary ` is the only description field on the ` Rule ` protocol — there is no separate ` description ` property. They are the same thing.
0 commit comments