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

Fix Typo in Update README.md #147

Merged
merged 2 commits into from
Nov 24, 2024
Merged

Fix Typo in Update README.md #147

merged 2 commits into from
Nov 24, 2024

Conversation

mdqst
Copy link
Contributor

@mdqst mdqst commented Nov 21, 2024

Description

This pull request fixes a typo in the example code for setting up API keys. Specifically, the following line contains an incorrect usage:

new PoapCompass('you_api_key'),

Error: you_api_key
Correction: It should be your_api_key.

Corrected code:

new PoapCompass('your_api_key'),

Reasoning:
The corrected version uses the grammatically appropriate form "your", which is the correct possessive form. This aligns with the rest of the document where "your_api_key" is used consistently. It follows standard conventions for API key examples and avoids the confusion caused by the incorrect usage of "you" as a possessive adjective.

This change ensures consistency and clarity in the documentation.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (if none of the other choices apply)

Checklist

  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated the documentation accordingly.

Fix Typo in API Key Example
Copy link

vercel bot commented Nov 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
poap-js ⬜️ Ignored (Inspect) Visit Preview Nov 24, 2024 5:05am

@jm42 jm42 requested a review from rlajous November 22, 2024 06:12
@jm42 jm42 merged commit 59e5a29 into poap-xyz:main Nov 24, 2024
3 checks passed
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.

2 participants