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.

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

Remove prefer-commenting-analyzer-ignores #160

Open
ngoc-quoc-huynh opened this issue Nov 14, 2024 · 5 comments
Open

Remove prefer-commenting-analyzer-ignores #160

ngoc-quoc-huynh opened this issue Nov 14, 2024 · 5 comments
Labels
Doc Improvements or additions to the documentation. Easy An easy and simple issue to start contributions Improvement New feature or request

Comments

@ngoc-quoc-huynh
Copy link

Since Dart introduced document_ignores, I think we can remove prefer-commenting-analyzer-ignores.
What do you think?

@ngoc-quoc-huynh ngoc-quoc-huynh added the Improvement New feature or request label Nov 14, 2024

Assign to review: @santitigaga @ajtortolero

@app-toolkit-opensource-innersource app-toolkit-opensource-innersource bot added the Review/Pending Initial stage of the issue to evaluate its approval label Nov 14, 2024
@santitigaga
Copy link
Contributor

@ngoc-quoc-huynh it's a good idea, but this rule is only available after dart 3.5. I'm sure than a lot of projects using DCL are using older versions. Whatever we can reference this dart rule in the DCL doc, and announce the deprecation of this rule in future releases.

Your help in adjusting this is appreciated. 💯

@santitigaga santitigaga added Doc Improvements or additions to the documentation. Easy An easy and simple issue to start contributions and removed Review/Pending Initial stage of the issue to evaluate its approval labels Nov 18, 2024
@ngoc-quoc-huynh
Copy link
Author

@santitigaga where and how can I mark this rule as deprecated and adjust the docs?

@santitigaga
Copy link
Contributor

@ngoc-quoc-huynh In the documentation you can add a toast alert where you indicate that the rule is deprecated and they should use the dart one...

Since rules are declared in the yaml file, it may be useful for the rule description to have a similar message.
If you have another idea you can propose it

@ngoc-quoc-huynh
Copy link
Author

@santitigaga So I need to update the GitHub wiki page, right? How can I submit a change there, do I need access to it? And how can I create a toast on the GitHub wiki?
Sorry, I'm pretty new to GitHub wiki.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc Improvements or additions to the documentation. Easy An easy and simple issue to start contributions Improvement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants