Skip to content

[various] Add unintended_html_in_doc_comment to analysis options#11303

Merged
auto-submit[bot] merged 7 commits intoflutter:mainfrom
stuartmorgan-g:unintended-html-analysis
Mar 25, 2026
Merged

[various] Add unintended_html_in_doc_comment to analysis options#11303
auto-submit[bot] merged 7 commits intoflutter:mainfrom
stuartmorgan-g:unintended-html-analysis

Conversation

@stuartmorgan-g
Copy link
Collaborator

Adds unintended_html_in_doc_comment to 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 pana deductions 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

Footnotes

  1. 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

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.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@stuartmorgan-g stuartmorgan-g added CICD Run CI/CD and removed CICD Run CI/CD labels Mar 19, 2026
@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 25, 2026
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Mar 25, 2026
@auto-submit
Copy link
Contributor

auto-submit bot commented Mar 25, 2026

autosubmit label was removed for flutter/packages/11303, because Pull request flutter/packages/11303 is not in a mergeable state.

@stuartmorgan-g stuartmorgan-g added CICD Run CI/CD autosubmit Merge PR when tree becomes green via auto submit App and removed CICD Run CI/CD labels Mar 25, 2026
@auto-submit auto-submit bot merged commit 371106f into flutter:main Mar 25, 2026
81 checks passed
@stuartmorgan-g stuartmorgan-g deleted the unintended-html-analysis branch March 25, 2026 14:00
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 25, 2026
github-merge-queue bot pushed a commit to flutter/flutter that referenced this pull request Mar 25, 2026
flutter/packages@8dcfd11...5909bdd

2026-03-25 47866232+chunhtai@users.noreply.github.com [ci] add more
permissions for create-pull-request (flutter/packages#11302)
2026-03-25 stuartmorgan@google.com [various] Add
`unintended_html_in_doc_comment` to analysis options
(flutter/packages#11303)
2026-03-25 matt.boetger@gmail.com Use deprecated dependency until legacy
renderer is removed (flutter/packages#11185)
2026-03-25 louisehsu@google.com [in_app_purchase_storekit] Address flaky
tests (flutter/packages#11270)
2026-03-25 stuartmorgan@google.com [google_maps_flutter] Fix A2A iOS
builds (flutter/packages#11290)
2026-03-25 stuartmorgan@google.com [mustache_template] Fix broken README
link (flutter/packages#11306)
2026-03-25 stuartmorgan@google.com [ci] Add a workflow to auto-remove
CICD label (flutter/packages#11301)
2026-03-25 stuartmorgan@google.com [various] Convert plugin builds to
Kotlin gradle (flutter/packages#11172)
2026-03-25 spkhalad@gmail.com [webview_flutter_platform_interface] Add
support for getting cookie (flutter/packages#11037)
2026-03-25 stuartmorgan@google.com [cupertino_icons] Remove empty Dart
file (flutter/packages#11308)
2026-03-25 stuartmorgan@google.com [camera] Regenerate iOS example with
Swift (flutter/packages#11283)
2026-03-25 tarrinneal@gmail.com [pigeon] Optimize data class equality
and hashing in Dart, Kotlin, java, and Swift, adds equality in other
languages (flutter/packages#11140)
2026-03-25 katelovett@google.com [two_dimensional_scrollables] Fix span
border decorations in flipped cross axes (flutter/packages#11334)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com on the revert to ensure that a
human
is aware of the problem.

To file a bug in Flutter:
https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
okorohelijah pushed a commit to okorohelijah/packages that referenced this pull request Mar 26, 2026
…lutter#11303)

Adds `unintended_html_in_doc_comment` to 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 `pana` deductions 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

[^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
mboetger pushed a commit to mboetger/flutter that referenced this pull request Mar 26, 2026
…er#184123)

flutter/packages@8dcfd11...5909bdd

2026-03-25 47866232+chunhtai@users.noreply.github.com [ci] add more
permissions for create-pull-request (flutter/packages#11302)
2026-03-25 stuartmorgan@google.com [various] Add
`unintended_html_in_doc_comment` to analysis options
(flutter/packages#11303)
2026-03-25 matt.boetger@gmail.com Use deprecated dependency until legacy
renderer is removed (flutter/packages#11185)
2026-03-25 louisehsu@google.com [in_app_purchase_storekit] Address flaky
tests (flutter/packages#11270)
2026-03-25 stuartmorgan@google.com [google_maps_flutter] Fix A2A iOS
builds (flutter/packages#11290)
2026-03-25 stuartmorgan@google.com [mustache_template] Fix broken README
link (flutter/packages#11306)
2026-03-25 stuartmorgan@google.com [ci] Add a workflow to auto-remove
CICD label (flutter/packages#11301)
2026-03-25 stuartmorgan@google.com [various] Convert plugin builds to
Kotlin gradle (flutter/packages#11172)
2026-03-25 spkhalad@gmail.com [webview_flutter_platform_interface] Add
support for getting cookie (flutter/packages#11037)
2026-03-25 stuartmorgan@google.com [cupertino_icons] Remove empty Dart
file (flutter/packages#11308)
2026-03-25 stuartmorgan@google.com [camera] Regenerate iOS example with
Swift (flutter/packages#11283)
2026-03-25 tarrinneal@gmail.com [pigeon] Optimize data class equality
and hashing in Dart, Kotlin, java, and Swift, adds equality in other
languages (flutter/packages#11140)
2026-03-25 katelovett@google.com [two_dimensional_scrollables] Fix span
border decorations in flipped cross axes (flutter/packages#11334)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com on the revert to ensure that a
human
is aware of the problem.

To file a bug in Flutter:
https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[packages] Enable unintended_html_in_doc_comment

3 participants