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

chore: Improve Scalebar example in readme #343

Merged

Conversation

DarrylBayliss
Copy link
Contributor

@DarrylBayliss DarrylBayliss commented Jul 21, 2023

This PR makes a small improvement to the readme documentation, showing a fuller example on how to use ScaleBar and DisappearingScaleBar.

I made the mistake of using these composables inside GoogleMap, causing the crash encountered in #335. The idea is this change makes it less likely others would do the same.

Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open a GitHub issue as a bug/feature request before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #335

Make readme documentation for Scalebar composable clearer.
@DarrylBayliss DarrylBayliss changed the title Improve Scalebar example in readme chore: Improve Scalebar example in readme Jul 21, 2023
@wangela
Copy link
Member

wangela commented Jul 28, 2023

Thank you for this improvement to the README! ack that instrumentation tests fail on forks; merging this since it's only a README edit.

@wangela wangela merged commit 2422f06 into googlemaps:main Jul 28, 2023
8 of 9 checks passed
@DarrylBayliss DarrylBayliss deleted the chore/update-scalebar-documentation branch July 30, 2023 21:49
@googlemaps-bot
Copy link
Contributor

🎉 This PR is included in version 2.13.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants