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: fix syntax error and improve docs in use-event-listener.md #136

Merged
merged 6 commits into from
Sep 29, 2024

Conversation

nberlette
Copy link
Contributor

Howdy! Really neat project you've got here. This is my first contribution, and it's
quite miniscule in size and scope, but I felt the need when I stumbled across this
little (probably typographical) syntax error:

export class ClickLogger() {

Changes

  1. fixes the aforementioned typo in the example snippet - allowing new users to copy + paste the demo to test out the useEventListener feature (without any hiccups)
  2. rewords a few minor things for improved clarity
  3. introduces a conclusion section at the end to sum up the demonstrated behavior
  4. adds a couple semicolons to the ClickCounter code... just to calm my OCD

Let me know if there's anything I missed, I'll gladly patch it in here.

Thanks!

- fixes the `class ClickLogger() {` typo.
- adds additional verbage and wording to improve the clarity
- adds a couple semicolons to the example class, because OCD
Copy link

changeset-bot bot commented Sep 27, 2024

⚠️ No Changeset found

Latest commit: 53c99f3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@nberlette
Copy link
Contributor Author

Whoops! It's been a little while since I used changesets - totally slipped my mind 😅 Just a second...

Copy link
Member

@huntabyte huntabyte left a comment

Choose a reason for hiding this comment

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

Awesome, no need to add a changeset for docs!

Copy link
Contributor

github-actions bot commented Sep 29, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
runed ✅ Ready (View Log) Visit Preview 53c99f3

@huntabyte huntabyte merged commit 9bc0996 into svecosystem:main Sep 29, 2024
4 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