Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Removal of nonfunctional package_api_docs lint #59554

Closed
parlough opened this issue Oct 11, 2024 · 1 comment
Closed

Removal of nonfunctional package_api_docs lint #59554

parlough opened this issue Oct 11, 2024 · 1 comment
Assignees
@parlough
Labels
analyzer-linter Issues with the analyzer's support for the linter package area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. P2 A bug or feature request we're likely to work on type-task A well-defined stand-alone task

Comments

@parlough
Copy link
Member

parlough commented Oct 11, 2024 •
edited
Loading

Background

The lint hasn't been functional for a long time. However, it has also been around and added to analysis options for a long time. Instead of trying to fix it and introducing a bunch of new warnings on SDK update, let's deprecate and promptly remove it.

Keeping it around in its current state sets false expectations for developers who expect it to be ensuring their package's libraries are well documented.

Replacement

If anyone is interested in proposing implementing a replacement, it can be added under a new name, so developers can be aware when they opt-in to enabling its new behavior. Please open a new lint proposal if you are interested in that work.

Removal plan

  1. Publish this issue as notice and for pointing to as a reference.
  2. Remove it from analysis_options.yaml files across the dart-lang and flutter organizations.
  3. Deprecate the lint in the SDK before the first Dart 3.7 beta release (cl/389585).
  4. Remove usages of the lint elsewhere across the open-source ecosystem.
  5. Depending on how the deprecation goes, remove the lint in either Dart 3.7 or 3.8.
@parlough parlough added the type-task A well-defined stand-alone task label Oct 11, 2024
@parlough parlough self-assigned this Oct 11, 2024
This was referenced Oct 11, 2024
Merged
Merged
Merged
Merged
auto-submit bot referenced this issue in flutter/flutter Oct 11, 2024
@parlough
Remove non-functional, deprecated package_api_docs lint (#156603)
2682633 
Reference: https://github.com/dart-lang/linter/issues/5107
@parlough parlough mentioned this issue Oct 11, 2024
Merged
parlough referenced this issue in flutter/codelabs Oct 12, 2024
@parlough
Remove inclusion of deprecated lints (#2248)
4380182 
Reference: https://github.com/dart-lang/linter/issues/5107
This was referenced Oct 12, 2024
Closed
Merged
auto-submit bot referenced this issue in flutter/packages Oct 14, 2024
@parlough
Disable non-functional, deprecated package_api_docs lint (#7858)
bf751e6 
Reference: https://github.com/dart-lang/linter/issues/5107
auto-submit bot referenced this issue in flutter/engine Oct 14, 2024
@parlough
Disable non-functional and deprecated package_api_docs lint (#55833)
99162a3 
Reference: https://github.com/dart-lang/linter/issues/5107
copybara-service bot referenced this issue Oct 14, 2024
@parlough
Stop enabling the package_api_docs lint
ffc82e6 
The lint is non-functional and will be deprecated soon.

Bug: https://github.com/dart-lang/linter/issues/5107
Change-Id: I4d4b75a6c7978f584bef37351514391f55761c55
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/389594
Reviewed-by: Johnni Winther <[email protected]>
Reviewed-by: Nate Bosch <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>
Auto-Submit: Parker Lougheed <[email protected]>
@pq pq added the P2 A bug or feature request we're likely to work on label Oct 15, 2024
@parlough parlough mentioned this issue Oct 16, 2024
Closed
1 task
parlough referenced this issue in parlough/flutter_portal Oct 16, 2024
@parlough
Remove non-functional package_api_docs lint
fe0e56c 
This lint hasn't been functional for a long time, so it's likely to removed (https://github.com/dart-lang/linter/issues/5107).
@parlough parlough mentioned this issue Oct 16, 2024
Merged
copybara-service bot referenced this issue Oct 16, 2024
@parlough
[linter] Deprecate package_api_docs lint
e032779 
The lint hasn't been functional for a long time. Rather than try to fix it and start introducing a lot of warnings on packages that include it, let's deprecate it and prepare for removal. Keeping it around in its current state results in the analyzer not meeting the expectations of developers that include the rule, potentially even causing misconceptions that an element isn't public when it is.

A replacement, with a new name, can be introduced in the future if there is the desire and time to implement it.

Bug: https://github.com/dart-lang/linter/issues/5107
Change-Id: Ied113e4c98be2253cb938277cfd6ea1c96bcac4a
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/389585
Reviewed-by: Phil Quitslund <[email protected]>
Auto-Submit: Parker Lougheed <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>
Commit-Queue: Samuel Rawlins <[email protected]>
@devoncarew devoncarew added analyzer-linter Issues with the analyzer's support for the linter package area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. labels Nov 20, 2024
@devoncarew devoncarew transferred this issue from dart-lang/linter Nov 20, 2024
@parlough
Copy link
Member Author

parlough commented Dec 5, 2024

This lint has been deprecated and removed from dependent repositories and major lint sets.

https://dart-review.googlesource.com/c/sdk/+/396780 is ready for review and finalizes the removal. Thanks all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@parlough parlough

Labels
analyzer-linter Issues with the analyzer's support for the linter package area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. P2 A bug or feature request we're likely to work on type-task A well-defined stand-alone task
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@pq @devoncarew @parlough