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

docs: highlight API key in Quick Start example #1014

Merged
merged 3 commits into from
Sep 12, 2023
Merged

docs: highlight API key in Quick Start example #1014

merged 3 commits into from
Sep 12, 2023

Conversation

bennycode
Copy link
Contributor

I updated the example value for "key" to highlight that it is the Maps API Key which must be provided.


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 #1013

@bennycode bennycode changed the title Patch 1 docs: Highlight API key in Quick Start example Jul 27, 2023
@bennycode bennycode changed the title docs: Highlight API key in Quick Start example docs: highlight API key in Quick Start example Jul 27, 2023
Copy link
Contributor

@usefulthink usefulthink left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution! I agree that it isn't very clear that "asdf" is supposed to be replaced with the API key.

@usefulthink usefulthink merged commit 22e6139 into googlemaps:master Sep 12, 2023
15 checks passed
@bennycode bennycode deleted the patch-1 branch September 12, 2023 15:26
googlemaps-bot added a commit that referenced this pull request Sep 12, 2023
### [3.3.38](v3.3.37...v3.3.38) (2023-09-12)

### Build System

* **deps-dev:** bump @types/node from 20.5.9 to 20.6.0 ([#1033](#1033)) ([dfca658](dfca658))
* **deps-dev:** bump prettier from 3.0.2 to 3.0.3 ([#1032](#1032)) ([798938f](798938f))
* **deps-dev:** bump typedoc from 0.25.0 to 0.25.1 ([#1031](#1031)) ([b1a7ef1](b1a7ef1))

### Documentation

* highlight API key in Quick Start example ([#1014](#1014)) ([22e6139](22e6139)), closes [#1013](#1013)
@googlemaps-bot
Copy link
Contributor

🎉 This PR is included in version 3.3.38 🎉

The release is available on:

Your semantic-release bot 📦🚀

Lipstickpro added a commit to Lipstickpro/google-maps-services-js that referenced this pull request Sep 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The provided API key is invalid
3 participants