-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Fix doc comment references to 'this' #150379
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.
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
Conversation
goderbauer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
| /// If `this.value` is set, [increasedValue] must also be provided and | ||
| /// [onIncrease] must ensure that `this.value` will be set to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should be:
| /// If `this.value` is set, [increasedValue] must also be provided and | |
| /// [onIncrease] must ensure that `this.value` will be set to | |
| /// If [value] is set, [increasedValue] must also be provided and | |
| /// [onIncrease] must ensure that [value] will be set to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
| /// If `this.value` is set, [decreasedValue] must also be provided and | ||
| /// [onDecrease] must ensure that `this.value` will be set to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| /// If `this.value` is set, [decreasedValue] must also be provided and | |
| /// [onDecrease] must ensure that `this.value` will be set to | |
| /// If [value] is set, [decreasedValue] must also be provided and | |
| /// [onDecrease] must ensure that [value] will be set to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
| } | ||
|
|
||
| /// Whether [this.value] should be obscured. | ||
| /// Whether `this.value` should be obscured. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| /// Whether `this.value` should be obscured. | |
| /// Whether [value] should be obscured. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
| /// This option is usually set in combination with [isTextField] to indicate | ||
| /// that the text field contains a password (or other sensitive information). | ||
| /// Doing so instructs screen readers to not read out [this.value]. | ||
| /// Doing so instructs screen readers to not read out `this.value`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| /// Doing so instructs screen readers to not read out `this.value`. | |
| /// Doing so instructs screen readers to not read out [value]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
|
|
||
| /// The currently selected text (or the position of the cursor) within | ||
| /// [this.value] if this node represents a text field. | ||
| /// `this.value` if this node represents a text field. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| /// `this.value` if this node represents a text field. | |
| /// [value] if this node represents a text field. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
goderbauer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Manual roll requested by [email protected] flutter/flutter@ccf3abe...6c06abb 2024-06-18 [email protected] Add test for engine artifact framework permissions (flutter/flutter#148786) 2024-06-18 [email protected] Add test for icon_button.3.dart (flutter/flutter#149988) 2024-06-18 [email protected] Roll Flutter Engine from 78fdd06af541 to 74f42ca3544c (6 revisions) (flutter/flutter#150421) 2024-06-18 [email protected] Fix transparent `dividerColor` breaks `TabBar.tabAlignment` (flutter/flutter#150350) 2024-06-18 [email protected] Fix scrollable `TabBar` jittering (flutter/flutter#150041) 2024-06-18 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Reland 3: [CupertinoActionSheet] Match colors to native (#150386)" (flutter/flutter#150413) 2024-06-18 [email protected] Extend the Windows web_tool_tests_1_2 shard timeout to 45 minutes (flutter/flutter#150393) 2024-06-18 [email protected] Roll Flutter Engine from 1c4e5e230ecb to 78fdd06af541 (3 revisions) (flutter/flutter#150403) 2024-06-18 [email protected] Roll Flutter Engine from a4f266f7eb1a to 1c4e5e230ecb (8 revisions) (flutter/flutter#150399) 2024-06-18 [email protected] Rename doc file to use standard hyphens (flutter/flutter#150314) 2024-06-17 [email protected] Fix typo in `SliverLayoutDimensions.hashCode` where not all properties are used in the hash code. (flutter/flutter#150306) 2024-06-17 [email protected] Fix doc comment references to 'this' (flutter/flutter#150379) 2024-06-17 [email protected] Add 'fail-fast' argument to flutter test (flutter/flutter#149587) 2024-06-17 [email protected] Update matchesGoldenFile documentation reference to goldenFileComparator (flutter/flutter#150343) 2024-06-17 [email protected] Reland 3: [CupertinoActionSheet] Match colors to native (flutter/flutter#150386) 2024-06-17 [email protected] [a11y] Add semantics: button to bottom navigation bar items and dropdown menu items (flutter/flutter#149375) 2024-06-17 [email protected] Reland "sliverGridDelegate mainAxisExtent add assert (#148470)" (flutter/flutter#149720) 2024-06-17 [email protected] `ScaffoldBackgroundColor` should default to `ColorScheme.surface` (flutter/flutter#149772) 2024-06-17 [email protected] Reland TreeSliver (flutter/flutter#149839) 2024-06-17 [email protected] Reland: [CupertinoActionSheet] Add sliding tap gesture (flutter/flutter#150219) 2024-06-17 [email protected] Roll Flutter Engine from 5989f0215fed to a4f266f7eb1a (1 revision) (flutter/flutter#150377) 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 Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: 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
Work towards dart-lang/dartdoc#3761
Sibling CL to https://dart-review.googlesource.com/c/sdk/+/365204
The analyzer has never recognized
[this]as a valid doc commentreference (and the
comment_referenceslint rule has similarlyreported such reference attempts). dartdoc has its own algorithms
for resolving comment references, which we are dismantling in favor
of a single resolution, provided by the analyzer.
We've also decided against adding support in the analyzer (see
dart-lang/sdk#58155), so these
reference attempts should be re-written.
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.