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: fixed docs for svelte/store methods fromStore and toStore not being rendered #14800

Closed
wants to merge 1 commit into from

Conversation

marekdedic
Copy link

@marekdedic marekdedic commented Dec 21, 2024

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

I copied the doc comments from the source - am I missing some script that should do that automatically?

Copy link

changeset-bot bot commented Dec 21, 2024

⚠️ No Changeset found

Latest commit: e55c763

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

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-svelte-14800-svelte.vercel.app/

this is an automated message

@marekdedic marekdedic force-pushed the store-rune-docs branch 2 times, most recently from 304b91c to 8334e32 Compare December 21, 2024 20:46
@marekdedic marekdedic changed the title Fixed docs for svelte/store not being rendered docs: fixed docs for svelte/store methods fromStore and toStore not being rendered Dec 21, 2024
@marekdedic marekdedic marked this pull request as ready for review December 21, 2024 22:50
Copy link

@Leonidaz Leonidaz left a comment

Choose a reason for hiding this comment

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

for team's consideration:

found the documentation on webarchive before Svelte 5 was launched that has the descriptions: https://web.archive.org/web/20240922152341/https://svelte-5-preview.vercel.app/docs/imports

@Rich-Harris
Copy link
Member

This doesn't fix it unfortunately — the file you edited is generated from source code. The underlying issue is sveltejs/svelte.dev#743

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