Skip to content

Conversation

@yaakovschectman
Copy link
Contributor

@yaakovschectman yaakovschectman commented Sep 12, 2024

Replace old JSON implementation of polyline start/end cap with a structured Pigeon.

flutter/flutter#154737

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of saying "the Cap class" consider linking to the source of that class.

I believe this is the correct class. https://developers.google.com/maps/documentation/android-sdk/reference/com/google/android/libraries/maps/model/Cap

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should this link to google map's SDK's Cap? I would have thought a link to the platform interface's Cap would be more appropriate, but do you disagree?

Copy link
Contributor

@reidbaker reidbaker Sep 13, 2024

Choose a reason for hiding this comment

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

I think the fact that you and I were thinking of different classes is a great explanation of why "the cap class" is not the right level of documentation.

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've linked here to the platform interface Cap, and from a couple other comments in this PR to the Maps SDK's Cap. Let me know if you agree with my choice of links.

Copy link
Contributor

Choose a reason for hiding this comment

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

Link to documentation so that someone can better understand these values.

Copy link
Contributor

Choose a reason for hiding this comment

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

No action required: You are following the pattern of the rest of this file but both this method name and documentation do not help me understand what is being converted here or how to learn about either the to or from object.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We could trivially improve them all a fair amount by using [] references for both class names. That was just an oversight on my part when I started converting.

Copy link
Contributor

Choose a reason for hiding this comment

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

Please use dart doc linking notation for the classes.

Copy link
Contributor

Choose a reason for hiding this comment

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

Link to cap documentation.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We could trivially improve them all a fair amount by using [] references for both class names. That was just an oversight on my part when I started converting.

Copy link
Collaborator

@stuartmorgan-g stuartmorgan-g 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 one incorrect comment removed.

// any time, so provide a fallback that ensures this won't break when used
// with a version that contains new values. This is deliberately outside
// the switch rather than a `default` so that the linter will flag the
// switch as needing an update.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This last sentence does not apply in this context. String-value enums cannot be exhaustive, so the linter will never flag this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Please use dart doc linking notation for the classes.

@stuartmorgan-g
Copy link
Collaborator

The last updates look to me like they address Reid's feedback, so I'm dismissing his change request to unblock landing since he's OOO for the moment.

@yaakovschectman yaakovschectman merged commit 44e7d73 into flutter:main Oct 9, 2024
75 checks passed
@yaakovschectman yaakovschectman deleted the pigeon_cap branch October 9, 2024 19:59
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 10, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 10, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Oct 10, 2024
flutter/packages@9d00fb1...f1a3da2

2024-10-09 matanlurey@users.noreply.github.com Remove additional (harmless but annoying) native stack traces. (flutter/packages#7837)
2024-10-09 engine-flutter-autoroll@skia.org Roll Flutter from 0917e9d to 2d45fb3 (50 revisions) (flutter/packages#7836)
2024-10-09 109111084+yaakovschectman@users.noreply.github.com [camera_android] Begin conversion to Pigeon (flutter/packages#7755)
2024-10-09 109111084+yaakovschectman@users.noreply.github.com [google_maps_flutter_android] Add `PlatformCap` pigeon type. (flutter/packages#7639)
2024-10-09 43054281+camsim99@users.noreply.github.com [camerax] Revert "Explicitly remove READ_EXTERNAL_STORAGE permission" (flutter/packages#7826)

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-flutter-autoroll
Please CC flutter-ecosystem@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants