Skip to content

Conversation

@gspencergoog
Copy link
Contributor

Description

Deprecate AnimatedListItemBuilder and AnimatedListRemovedItemBuilder in favor of AnimatedItemBuilder and AnimatedRemovedItemBuilder, since they have the same signature, and just need a new, more appropriate, name.

Tests

  • No tests needed: just a refactor without a semantic difference.

@flutter-dashboard flutter-dashboard bot added d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos documentation f: scrolling Viewports, list views, slivers, etc. framework flutter/packages/flutter repository. See also f: labels. c: contributor-productivity Team-specific productivity, code health, technical debt. labels Oct 7, 2022
@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@gspencergoog gspencergoog requested a review from Piinks October 7, 2022 22:41
@gspencergoog gspencergoog force-pushed the deprecate_list_item_builder branch from 9c7878a to 3825134 Compare October 7, 2022 22:49
Copy link
Contributor

Choose a reason for hiding this comment

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

I think '//' is probably more appropriate here because as it stands we probably wouldn't want the exact text here as dartdocs (for example, it doesn't have a leading line that says what it is). As it stands, it's a comment (a good one, that explains what the example is about).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I hear what you're saying, and I know what the style guide says, but consider these three things:

  1. if they are dartdoc comments, then the [AnimatedRemovedItemBuilder] becomes a link that could be quite helpful to the user to click on in an IDE. Otherwise, it just looks like a piece of text that wishes it were a link.
  2. This is in the examples, which aren't actually processed by dartdoc.
  3. It's on a private interface that, even if the examples were processed by dartdoc, would not show up in the output.

That said, I'm happy to either spruce up the comment so it's "good enough" to be a dartdoc comment, or remove the brackets and make it a "regular" comment that doesn't try to link to the symbols.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I went with "sprucing it up"...

Copy link
Contributor

Choose a reason for hiding this comment

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

same here

Copy link
Contributor

Choose a reason for hiding this comment

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

might be more reassuring for people if this said "use the identical [...]"?

@Hixie
Copy link
Contributor

Hixie commented Oct 7, 2022

test-exempt: code refactor with no semantic change

Copy link
Contributor

@Hixie Hixie left a comment

Choose a reason for hiding this comment

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

LGTM

…in favor of AnimatedItemBuilder and AnimatedRemovedItemBuilder
@gspencergoog gspencergoog force-pushed the deprecate_list_item_builder branch 2 times, most recently from f591c53 to e8e8267 Compare October 8, 2022 01:12
@gspencergoog gspencergoog added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 8, 2022
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Oct 8, 2022
@auto-submit
Copy link
Contributor

auto-submit bot commented Oct 8, 2022

auto label is removed for flutter/flutter, pr: 113131, due to - The status or check suite Linux web_tests_5 has failed. Please fix the issues identified (or deflake) before re-applying this label.

@goderbauer goderbauer added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 10, 2022
@auto-submit auto-submit bot merged commit 1730662 into flutter:master Oct 10, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 11, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App c: contributor-productivity Team-specific productivity, code health, technical debt. d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos f: scrolling Viewports, list views, slivers, etc. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants