-
Notifications
You must be signed in to change notification settings - Fork 170
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.
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
Removal of nonfunctional package_api_docs
lint
#5107
Comments
This was referenced Oct 11, 2024
parlough
added a commit
to flutter/codelabs
that referenced
this issue
Oct 12, 2024
This was referenced Oct 12, 2024
copybara-service bot
pushed a commit
to dart-lang/sdk
that referenced
this issue
Oct 14, 2024
The lint is non-functional and will be deprecated soon. Bug: dart-lang/linter#5107 Change-Id: I4d4b75a6c7978f584bef37351514391f55761c55 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/389594 Reviewed-by: Johnni Winther <johnniwinther@google.com> Reviewed-by: Nate Bosch <nbosch@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Samuel Rawlins <srawlins@google.com> Auto-Submit: Parker Lougheed <parlough@gmail.com>
Open
1 task
parlough
added a commit
to parlough/flutter_portal
that referenced
this issue
Oct 16, 2024
This lint hasn't been functional for a long time, so it's likely to removed (dart-lang/linter#5107).
copybara-service bot
pushed a commit
to dart-lang/sdk
that referenced
this issue
Oct 16, 2024
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: dart-lang/linter#5107 Change-Id: Ied113e4c98be2253cb938277cfd6ea1c96bcac4a Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/389585 Reviewed-by: Phil Quitslund <pquitslund@google.com> Auto-Submit: Parker Lougheed <parlough@gmail.com> Reviewed-by: Samuel Rawlins <srawlins@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
analysis_options.yaml
files across thedart-lang
andflutter
organizations.The text was updated successfully, but these errors were encountered: