Exclude deprecated rule options from Rules.md

nicklockwood · Jun 9, 2024 · 7d6174d · 7d6174d
1 parent f8622a9
commit 7d6174d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/Rules.md b/Rules.md
@@ -2586,7 +2586,6 @@ Option | Description
 --- | ---
 `--funcattributes` | Function @attributes: "preserve", "prev-line", or "same-line"
 `--typeattributes` | Type @attributes: "preserve", "prev-line", or "same-line"
-`--varattributes` | Property @attributes: "preserve", "prev-line", or "same-line"
 `--storedvarattrs` | Stored var @attribs: "preserve", "prev-line", or "same-line"
 `--computedvarattrs` | Computed var @attribs: "preserve", "prev-line", "same-line"
 

diff --git a/Tests/MetadataTests.swift b/Tests/MetadataTests.swift
@@ -86,8 +86,11 @@ class MetadataTests: XCTestCase {
  if !rule.options.isEmpty {
  result += "\n\nOption | Description\n--- | ---"
  for option in rule.options {
- let help = Descriptors.byName[option]!.help
- result += "\n`--\(option)` | \(help)"
+ let descriptor = Descriptors.byName[option]!
+ guard !descriptor.isDeprecated else {
+ continue
+ }
+ result += "\n`--\(option)` | \(descriptor.help)"
  }
  }
  if let examples = rule.examples {