chore: Change the confusing parameter position to a clear name. #637
#638
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
JSpiner
force-pushed
the
main
branch
2 times, most recently
from
7c63b15 to
34a1a7d
Compare
JSpiner
changed the title
parameter position to a clear name. #637parameter position to a clear name. #637
|
I resolved the conflict. |
|
Hi @JSpiner . This is a reasonable proposal. Typically we would like to not drop a breaking change, but to propose a transition time for folks to change. I think we could offer an alternative constructor to the current one, deprecate the former and leave folks one version to upgrade to the new one. We could eventually pack this PR with another breaking change. |
| */ | ||
| @StateFactoryMarker | ||
| public operator fun invoke( | ||
| position: LatLng = LatLng(0.0, 0.0) | ||
| ): MarkerState = MarkerState(position) | ||
| initialPosition: LatLng = LatLng(0.0, 0.0) |
There was a problem hiding this comment.
I don't see the rationale for changing the parameter name here. Makes sense for rememberMarkerState, but not here. If you end up recomposing MarkerState.invoke(position) you will get a new MarkerState object.
It may look tempting because of the "initial marker position" KDoc verbiage, but that's how State objects generally work, including MutableState. It's mutableStateOf(value="bla").
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #637 🦕
It may be confusing that it is automatically updated by the
positionparameter. I renamed it toinitialPositionto make it clear that it only works with the initial value.(The compose foundation libraries also add the init prefix to the initial values that go into rememberXXX.)