Skip to content
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

Deprecate FollowPuckViewportStateOptions.animationDurationMs. #1256

Merged
merged 3 commits into from
Apr 5, 2022

Conversation

pengdev
Copy link
Member

@pengdev pengdev commented Apr 4, 2022

Summary of changes

This PR deprecates FollowPuckViewportStateOptions.animationDurationMs, the transition will will handled properly by the Viewport plugin internally.

User impact (optional)

Pull request checklist:

  • Briefly describe the changes in this PR.
  • Include before/after visuals or gifs if this PR includes visual changes.
  • Write tests for all new functionality. If tests were not written, please explain why.
  • Optimize code for java consumption (@JvmOverloads, @file:JvmName, etc).
  • Add example if relevant.
  • Document any changes to public APIs.
  • Run make update-api to update generated api files, if there's public API changes, otherwise the verify-api-* CI steps might fail.
  • Update CHANGELOG.md or use the label 'skip changelog', otherwise check changelog CI step will fail.
  • If this PR is a v10.[version] release branch fix / enhancement, merge it to main firstly and then port to v10.[version] release branch.

Fixes: < Link to related issues that will be fixed by this pull request, if they exist >

PRs must be submitted under the terms of our Contributor License Agreement CLA.

@pengdev pengdev requested a review from a team as a code owner April 4, 2022 15:04
@pengdev pengdev self-assigned this Apr 4, 2022
CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Ankur Khandelwal <ankur.khandelwal@mapbox.com>
@@ -60,6 +60,7 @@ class FollowPuckViewportStateOptions private constructor(
*
* Defaults to [DEFAULT_STATE_ANIMATION_DURATION_MS] milliseconds
*/
@Deprecated("AnimationDurationMs is not needed any more, the transition will be handled properly internally.")
Copy link
Contributor

@kiryldz kiryldz Apr 5, 2022

Choose a reason for hiding this comment

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

I assume internally it's not handled for now - that's why we can't drop it right now, correct?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, the actual fix will land in rc.1, we don't want to rush the fix itself, Deprecate affects public API, so that's why we add the Deprecated in beta.1

Copy link
Contributor

@kiryldz kiryldz left a comment

Choose a reason for hiding this comment

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

LGTM with a question

@pengdev pengdev merged commit ee09ca2 into main Apr 5, 2022
@pengdev pengdev deleted the peng-deprecate-followpuckviewport-animationduration branch April 5, 2022 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants