chore: Remove the package_api_docs lint in next release (#118)

* chore: Remove the `package_api_docs` lint in next release * chore: Remove the `package_api_docs` lint in next release
VeryGoodOpenSource · Oct 30, 2024 · f26bce6 · f26bce6
1 parent 33f05a1
commit f26bce6
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -125,6 +125,7 @@ Below is a list of rules that are not enabled by default together with the reaso
 | [`unreachable_from_main`](https://dart.dev/tools/linter-rules/unreachable_from_main)                                                                       | Not specified                                                                                                                |
 | [`unsafe_html`](https://dart.dev/tools/linter-rules/unsafe_html)                                                                                           | Not specified                                                                                                                |
 | [`use_decorated_box`](https://dart.dev/tools/linter-rules/use_decorated_box)                                                                               | [Has unresolved malfunctions](https://github.com/dart-lang/linter/issues/3286)                                               |
+| [`package_api_docs`](https://dart.dev/tools/linter-rules/package_api_docs)                                                                                 | Has been deprecated and [will be removed](https://github.com/dart-lang/linter/issues/5107)                                   |
 
 <!-- end:excluded_rules_table -->
 

diff --git a/lib/analysis_options.7.0.0.yaml b/lib/analysis_options.7.0.0.yaml
@@ -110,7 +110,6 @@ linter:
     - one_member_abstracts
     - only_throw_errors
     - overridden_fields
-    - package_api_docs
     - package_names
     - parameter_assignments
     - prefer_adjacent_string_concatenation

diff --git a/tool/linter_rules/exclusion_reasons.json b/tool/linter_rules/exclusion_reasons.json
@@ -30,5 +30,6 @@
   "unnecessary_null_aware_operator_on_extension_on_nullable": "Not specified",
   "unreachable_from_main": "Not specified",
   "unsafe_html": "Not specified",
-  "use_decorated_box": "[Has unresolved malfunctions](https://github.com/dart-lang/linter/issues/3286)"
+  "use_decorated_box": "[Has unresolved malfunctions](https://github.com/dart-lang/linter/issues/3286)",
+  "package_api_docs": "Has been deprecated and [will be removed](https://github.com/dart-lang/linter/issues/5107)"
 }