[various] Add unintended_html_in_doc_comment to analysis options#11303
[various] Add unintended_html_in_doc_comment to analysis options#11303stuartmorgan-g wants to merge 6 commits intoflutter:mainfrom
unintended_html_in_doc_comment to analysis options#11303Conversation
| import 'package:camera_web/src/types/types.dart'; | ||
| import 'package:mockito/annotations.dart'; | ||
| import 'package:mockito/mockito.dart'; | ||
| // TODO(srujzs): This is exported in `package:web` 0.6.0. Remove this when it is available. |
There was a problem hiding this comment.
This was just opportunistic cleanup to a test file I was already editing, since I happened to notice it. We already require package:web 1.0+ for example.
There was a problem hiding this comment.
Code Review
This pull request introduces the unintended_html_in_doc_comment lint rule to the analysis options and addresses violations across several packages. The changes primarily involve replacing HTML-like tags in Dart doc comments with markdown code blocks (e.g., changing <T> to <T> or adding ```dart blocks for code examples). This is a valuable improvement for documentation clarity and consistency, aligning with best practices for Dartdoc. Version numbers in pubspec.yaml and `CHANGELOG.md` files have been updated accordingly for the affected packages.
Adds
unintended_html_in_doc_commentto our analysis options, and fixes violations.This does a version bump even for cases where the comments being fixed are internal, because part of the goal here is to eliminate
panadeductions on pub.dev, and that doesn't take into account whether the violation is client-facing or just package-developer-facing.Fixes flutter/flutter#183860
Pre-Review Checklist
[shared_preferences]///).Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2