Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Clarify deprecation notice for jumpToWithoutSettling in scroll_position.dart #167200

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

dogaozyagci
Copy link

Description

Improved the @Deprecated message for jumpToWithoutSettling to clarify the risks
and suggest appropriate alternatives like jumpTo or using a custom ScrollPosition.

This makes the warning more informative for developers, in line with Flutter's documentation practices.

Checklist

  • Documentation-only change
  • No functional logic modified
  • Analysis and tests unaffected

@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

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.If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

@github-actions github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: scrolling Viewports, list views, slivers, etc. labels Apr 15, 2025
Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

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

LGTM 👍 . Indeed that's an improved deprecation message, thanks for cleaning this up.

/// Creates a widget that builds its child while assigning it a key.
///
/// This is useful when you want to preserve the state of a widget when it moves
/// around in the widget tree by associating it with a consistent key.
Copy link
Contributor

Choose a reason for hiding this comment

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

Just double checking, but did you mean to include this docs change in this PR? Fine either way as it looks like an improvement as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

I looks like these are from #167198

@justinmc justinmc requested a review from Piinks April 22, 2025 22:13
@justinmc
Copy link
Contributor

Does the customer testing failure look like something to be concerned about? I missed that at first.

@Piinks
Copy link
Contributor

Piinks commented Apr 30, 2025

Rebasing to see if it resolves the customer_testing failure.

@Piinks Piinks force-pushed the clarify-deprecation-jumpToWithoutSettling branch from b42cbaa to e19026a Compare April 30, 2025 02:07
Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

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

This deprecation message update LGTM as well, can you remove the other doc changes that are in the other linked PR?

/// Creates a widget that builds its child while assigning it a key.
///
/// This is useful when you want to preserve the state of a widget when it moves
/// around in the widget tree by associating it with a consistent key.
Copy link
Contributor

Choose a reason for hiding this comment

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

I looks like these are from #167198

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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