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

Update the docs for unintended_html_in_doc_comment #5050

Closed
devoncarew opened this issue Aug 7, 2024 · 4 comments
Closed

Update the docs for unintended_html_in_doc_comment #5050

devoncarew opened this issue Aug 7, 2024 · 4 comments
Assignees
@kallentu
Labels
P2 A bug or feature request we're likely to work on type-documentation A request to add or improve documentation type-enhancement A request for a change that isn't a bug

Comments

@devoncarew
Copy link
Member

devoncarew commented Aug 7, 2024 •
edited
Loading

We'd like to add unintended_html_in_doc_comment to the package:lints lint set, in the core set of lints. Before we do that we'd need to graduate the lint out of experimental and would like some documentation updates (as per dart-lang/lints#192 (comment)).

@kallentu, I see you authored this lint. Are you the best person to update the lint? @pq?
@devoncarew devoncarew mentioned this issue Aug 7, 2024
Closed
@devoncarew
Copy link
Member Author

Updated the above to reflect that we don't need to toggle the experimental state here.

@devoncarew devoncarew changed the title Update the docs for unintended_html_in_doc_comment and graduate the lint out of experimental Update the docs for unintended_html_in_doc_comment Aug 7, 2024
@pq pq transferred this issue from dart-lang/sdk Aug 7, 2024
@pq pq added P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug type-documentation A request to add or improve documentation labels Aug 7, 2024
@pq
Copy link
Member

pq commented Aug 7, 2024

@kallentu: let me know if you don't have cycles/interest and I'm happy to pitch in.

@kallentu kallentu self-assigned this Aug 8, 2024
copybara-service bot pushed a commit to dart-lang/sdk that referenced this issue Aug 12, 2024
@kallentu
[linter] Update documentation and regex for unintended_html_in_doc_co…
df283fd 
…mment lint.

Fix the documentation and make it more clear for users.
Added the allowlist of tags that won't be linted.

The regex for what is considered an unintended HTML tag has been updated.

Fixes dart-lang/linter#5055
Bug: dart-lang/linter#5050
Change-Id: I1963eb6878dd15d4a408be4ba6c2a4ba5f1d2e49
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/379519
Reviewed-by: Phil Quitslund <pquitslund@google.com>
Commit-Queue: Kallen Tu <kallentu@google.com>
Reviewed-by: Lasse Nielsen <lrn@google.com>
@kallentu
Copy link
Member

Docs should be updated now. Closing.

@devoncarew
Copy link
Member Author

Thanks!

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

@kallentu kallentu

Labels
P2 A bug or feature request we're likely to work on type-documentation A request to add or improve documentation type-enhancement A request for a change that isn't a bug
Projects
None yet
Milestone
No milestone
Development

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