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: Adjust docs for snippet typing to be more explicit #15167

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

snide
Copy link
Contributor

@snide snide commented Jan 31, 2025

I found the Snippet docs a little opaque in regard to typing. I think in this case it's best to be explicit with the typing, rather than use a generic, because the shape of the example is consistent throughout the page.

As an aside, I might even suggest an "Advanced patterns" section with Snippets that shows how snippet parameters can be spread to a render since that is extremely common in Svelte components in practice. I'm happy to construct an example like that if needed in a second PR.

This is only my second PR against the docs, so please let me know if I've made any stylistic or pattern errors.

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.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

Copy link

changeset-bot bot commented Jan 31, 2025

⚠️ No Changeset found

Latest commit: 9375dac

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

Copy link
Contributor

Playground

pnpm add https://pkg.pr.new/svelte@15167

@dummdidumm
Copy link
Member

I tend to agree that a generic is not necessarily needed in a lot of cases, but it would be good to have the generic mentioned somewhere, maybe as a sentence afterwards ("For more generic reusable components, you could even use generic types to declare the relationship between them", and then another snippet).

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