Skip to content

docs: mention that snippets can only be called through @render #15518

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

Conversation

HoldYourWaffle
Copy link
Contributor

See #15517.

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 Mar 15, 2025

⚠️ No Changeset found

Latest commit: 98a55e4

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

@svelte-docs-bot
Copy link

Copy link
Contributor

Playground

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

@Rich-Harris
Copy link
Member

Thanks for the PR. With the warning in #15521 I think the documentation change is unnecessary — people will find out when they need to find out — so I'll close this

@HoldYourWaffle
Copy link
Contributor Author

Understandable, thanks for all the great work!

@HoldYourWaffle HoldYourWaffle deleted the docs--snippets-only-render branch April 11, 2025 00:14
@axel7083
Copy link

axel7083 commented Apr 14, 2025

Thanks for the PR. With the warning in #15521 I think the documentation change is unnecessary — people will find out when they need to find out — so I'll close this

Hey @Rich-Harris, this piece of documentation would have been helpful because sometime we don't test with snippet our component, and people will provide it as props (just happened in our codebase), and this scenario could have been catch if the documentation was mentioning this

@HoldYourWaffle HoldYourWaffle restored the docs--snippets-only-render branch April 14, 2025 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants