Skip to content

docs: fix type signature for StartStopNotifier #8509

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

Merged
merged 1 commit into from
Apr 18, 2023

Conversation

gtm-nayan
Copy link
Contributor

@gtm-nayan gtm-nayan commented Apr 17, 2023

It (ab)used the Subscriber type to represent the signature of the set function and the Unsubscriber to represent the cleanup callback. But the names of the types made their purpose confusing to comprehend.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with npm test and lint the project with npm run lint

It used the Subscriber type to represent the set callback and the
Unsubscriber to represent the cleanup callback. But the names made
it confusing what it was for.
@vercel
Copy link

vercel bot commented Apr 17, 2023

@gtm-nayan is attempting to deploy a commit to the Svelte Team on Vercel.

A member of the Team first needs to authorize it.

@PuruVJ
Copy link
Collaborator

PuruVJ commented Apr 17, 2023

This is much better for the upcoming docs site as well 🔥

@dummdidumm dummdidumm merged commit 6e1674e into sveltejs:master Apr 18, 2023
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.

3 participants