[pigeon]: Correct comment references in doc comments#11129
Merged
auto-submit[bot] merged 2 commits intoflutter:mainfrom Feb 26, 2026
Merged
[pigeon]: Correct comment references in doc comments#11129auto-submit[bot] merged 2 commits intoflutter:mainfrom
auto-submit[bot] merged 2 commits intoflutter:mainfrom
Conversation
![gemini-code-assist[bot]](proxy.php?url=https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates documentation comments in packages/pigeon/lib/src/generator_tools.dart. The changes primarily involve correcting comment references to use square brackets for parameters and methods (e.g., [input], [addScoped]) and improving the phrasing of comments for clarity and grammatical correctness. For instance, the documentation for the Indent.format method's trimIndentation parameter has been expanded for better understanding.
Contributor
Author
|
None of the changes here are to public API comments. Does this require a CHANGELOG note then? |
tarrinneal
approved these changes
Feb 26, 2026
Contributor
tarrinneal
left a comment
tarrinneal
left a comment
There was a problem hiding this comment.
solid improvements, thank you
Contributor
|
@stuartmorgan-g more exceptions |
Collaborator
|
version/changelog override: no client-facing effect since these aren't exported. (The script doesn't do complex analysis so this kind of false positive is expected.) |
stuartmorgan-g
added
override: no versioning needed
stuartmorgan-g
added
the
autosubmit
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Feb 27, 2026
github-merge-queue bot
pushed a commit
to flutter/flutter
that referenced
this pull request
Feb 27, 2026
flutter/packages@e1d0169...a27d7c5 2026-02-26 [email protected] [pigeon] Tidy GeneratorAdapters to be const, with getters instead of fields (flutter/packages#11131) 2026-02-26 [email protected] [webview_flutter] Remove usesCleartextTraffic (flutter/packages#11124) 2026-02-26 [email protected] [pigeon]: Correct comment references in doc comments (flutter/packages#11129) 2026-02-26 [email protected] [webview_flutter_android] Remove usesCleartextTraffic (flutter/packages#11122) 2026-02-26 [email protected] Roll Flutter from dad6f9d to b31548f (39 revisions) (flutter/packages#11116) 2026-02-26 [email protected] [espresso] Remove usesCleartextTraffic (flutter/packages#11125) 2026-02-26 [email protected] [pigeon] Use function types in order to avoid dynamic calls (flutter/packages#11130) 2026-02-26 [email protected] [shared_preferences] Revert androidx.datastore:datastore to 1.1.7 (flutter/packages#11128) 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 [email protected] 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
xxxOVALxxx
pushed a commit
to xxxOVALxxx/flutter
that referenced
this pull request
Mar 10, 2026
…r#183009) flutter/packages@e1d0169...a27d7c5 2026-02-26 [email protected] [pigeon] Tidy GeneratorAdapters to be const, with getters instead of fields (flutter/packages#11131) 2026-02-26 [email protected] [webview_flutter] Remove usesCleartextTraffic (flutter/packages#11124) 2026-02-26 [email protected] [pigeon]: Correct comment references in doc comments (flutter/packages#11129) 2026-02-26 [email protected] [webview_flutter_android] Remove usesCleartextTraffic (flutter/packages#11122) 2026-02-26 [email protected] Roll Flutter from dad6f9d to b31548f (39 revisions) (flutter/packages#11116) 2026-02-26 [email protected] [espresso] Remove usesCleartextTraffic (flutter/packages#11125) 2026-02-26 [email protected] [pigeon] Use function types in order to avoid dynamic calls (flutter/packages#11130) 2026-02-26 [email protected] [shared_preferences] Revert androidx.datastore:datastore to 1.1.7 (flutter/packages#11128) 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 [email protected] 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several doc comments had missed comment references or erroneous comment references. Also a few grammar nits are fixed.
[Foo] [Bar]is a Markdown reference link, which presents "Foo" text, linking to a reference "Bar". In order to make this link toFooandBar, we need a word in between.Pre-Review Checklist
[shared_preferences]///).