Skip to content

[multi] Remove @tool from docs that does not work#9394

Merged
auto-submit[bot] merged 3 commits intoflutter:mainfrom
Piinks:fixDocs
Jun 6, 2025
Merged

[multi] Remove @tool from docs that does not work#9394
auto-submit[bot] merged 3 commits intoflutter:mainfrom
Piinks:fixDocs

Conversation

@Piinks
Copy link
Contributor

@Piinks Piinks commented Jun 5, 2025 •
edited
Loading

Screenshot 2025-06-05 at 6 10 11 PM

Usage of @tool sample and @tool snippet are not rendered in package docs here like they are in flutter/flutter.

Pre-Review Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

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 ↩3

@Piinks Piinks requested a review from stuartmorgan-g June 5, 2025 23:17
@Piinks Piinks added the override: no versioning needed Override the check requiring version bumps for most changes label Jun 5, 2025
@Piinks Piinks requested a review from bparrishMines as a code owner June 5, 2025 23:17
@Piinks Piinks added the override: no changelog needed Override the check requiring CHANGELOG updates for most changes label Jun 5, 2025
@Piinks Piinks requested a review from chunhtai as a code owner June 5, 2025 23:17
@Piinks
Copy link
Contributor Author

Piinks commented Jun 5, 2025

Changelog override: immaterial docs change
Versioning override: immaterial docs change
Test exemption: docs only change.

@stuartmorgan-g
Copy link
Collaborator

stuartmorgan-g commented Jun 6, 2025

Changelog override: immaterial docs change
Versioning override: immaterial docs change

We don't want the UI in the PR description screenshot to get this fix?

@Piinks
Copy link
Contributor Author

Piinks commented Jun 6, 2025

Sure, I figured it would go out next time. Did not seem particularly critical, especially since these have been there for quite a while.
But I will go ahead and schedule these for a release.

@Piinks Piinks removed override: no versioning needed Override the check requiring version bumps for most changes override: no changelog needed Override the check requiring CHANGELOG updates for most changes labels Jun 6, 2025
chunhtai
chunhtai approved these changes Jun 6, 2025
View reviewed changes
Copy link
Contributor

@chunhtai chunhtai left a comment

Choose a reason for hiding this comment

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

LGTM

@Piinks Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 6, 2025
@auto-submit auto-submit bot merged commit c05fd0b into flutter:main Jun 6, 2025
80 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 9, 2025
@engine-flutter-autoroll
c05fd0b [multi] Remove @tool from docs that does not work (flutter/pa…
fe6f4b4 
…ckages#9394)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 9, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 9, 2025
@engine-flutter-autoroll
c05fd0b [multi] Remove @tool from docs that does not work (flutter/pa…
ac1fdb7 
…ckages#9394)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 9, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 10, 2025
@engine-flutter-autoroll
c05fd0b [multi] Remove @tool from docs that does not work (flutter/pa…
7ea7cd2 
…ckages#9394)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 10, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 10, 2025
@engine-flutter-autoroll
c05fd0b [multi] Remove @tool from docs that does not work (flutter/pa…
21eb66f 
…ckages#9394)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 10, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 10, 2025
@engine-flutter-autoroll
c05fd0b [multi] Remove @tool from docs that does not work (flutter/pa…
e2401cc 
…ckages#9394)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 10, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 11, 2025
@engine-flutter-autoroll
c05fd0b [multi] Remove @tool from docs that does not work (flutter/pa…
f10512c 
…ckages#9394)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 11, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 11, 2025
@engine-flutter-autoroll
c05fd0b [multi] Remove @tool from docs that does not work (flutter/pa…
b0d0874 
…ckages#9394)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 11, 2025
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 11, 2025
@engine-flutter-autoroll
c05fd0b [multi] Remove @tool from docs that does not work (flutter/pa…
5e0a1d1 
…ckages#9394)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 11, 2025
Merged
github-merge-queue bot pushed a commit to flutter/flutter that referenced this pull request Jun 11, 2025
@engine-flutter-autoroll
Roll Packages from 974f152 to 0b322a2 (9 revisions) (#170462)
0e857f8 
flutter/packages@974f152...0b322a2

2025-06-11 stuartmorgan@google.com Roll Flutter master to 2d9977c
(flutter/packages#9402)
2025-06-11 stuartmorgan@google.com [google_maps_flutter] Fix iOS
analysis for newer Xcode (flutter/packages#9415)
2025-06-10 shaunpanjabi@gmail.com [in_app_purchase] Return
jwsRepresentation and jsonRepresentation for StoreKit2
(flutter/packages#9280)
2025-06-10 stuartmorgan@google.com Roll Flutter master to 7e30df2
(flutter/packages#9413)
2025-06-10 42757204+wyqlxf@users.noreply.github.com [vector_graphics]Add
Null Check for Image Retrieval in listener.dart's onDrawImage Function
(flutter/packages#9211)
2025-06-10 stuartmorgan@google.com Roll Flutter master to 8b22f67
(flutter/packages#9407)
2025-06-06 stuartmorgan@google.com Roll Flutter master to d8baa77
(flutter/packages#9379)
2025-06-06 ybz975218925@gmail.com Fix the `zIndex`-related issue in the
`copyWith` method. (flutter/packages#9396)
2025-06-06 katelovett@google.com [multi] Remove @tool from docs that
does not work (flutter/packages#9394)

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
Ortes pushed a commit to Ortes/packages that referenced this pull request Jun 25, 2025
@Piinks @Ortes
[multi] Remove @tool from docs that does not work (flutter#9394)
13ea40c 
![Screenshot 2025-06-05 at 6 10 11 PM](https://github.com/user-attachments/assets/7f6515c4-bc23-4574-b5b2-e3e411bb44e6)

Usage of `@tool sample` and `@tool snippet` are not rendered in package docs here like they are in flutter/flutter.

## 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 Jul 21, 2025
@engine-flutter-autoroll @mboetger
Roll Packages from 974f152 to 0b322a2 (9 revisions) (flutter#170462)
a119e9c 
flutter/packages@974f152...0b322a2

2025-06-11 stuartmorgan@google.com Roll Flutter master to 2d9977c
(flutter/packages#9402)
2025-06-11 stuartmorgan@google.com [google_maps_flutter] Fix iOS
analysis for newer Xcode (flutter/packages#9415)
2025-06-10 shaunpanjabi@gmail.com [in_app_purchase] Return
jwsRepresentation and jsonRepresentation for StoreKit2
(flutter/packages#9280)
2025-06-10 stuartmorgan@google.com Roll Flutter master to 7e30df2
(flutter/packages#9413)
2025-06-10 42757204+wyqlxf@users.noreply.github.com [vector_graphics]Add
Null Check for Image Retrieval in listener.dart's onDrawImage Function
(flutter/packages#9211)
2025-06-10 stuartmorgan@google.com Roll Flutter master to 8b22f67
(flutter/packages#9407)
2025-06-06 stuartmorgan@google.com Roll Flutter master to d8baa77
(flutter/packages#9379)
2025-06-06 ybz975218925@gmail.com Fix the `zIndex`-related issue in the
`copyWith` method. (flutter/packages#9396)
2025-06-06 katelovett@google.com [multi] Remove @tool from docs that
does not work (flutter/packages#9394)

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

Reviewers

@chunhtai chunhtai chunhtai approved these changes

@stuartmorgan-g stuartmorgan-g Awaiting requested review from stuartmorgan-g

@bparrishMines bparrishMines Awaiting requested review from bparrishMines bparrishMines is a code owner

Assignees

No one assigned

Labels

autosubmit Merge PR when tree becomes green via auto submit App p: go_router p: webview_flutter

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Piinks @stuartmorgan-g @chunhtai

Comments