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: clarify use:enhance compatibility with method="POST" #12546

Merged
merged 2 commits into from
Oct 9, 2024

Conversation

garysassano
Copy link
Contributor

@garysassano garysassano commented Aug 4, 2024

This PR aims to improve the documentation by explicitly stating that use:enhance is only compatible with forms using method="POST". Despite the fact that using use:enhance with other methods should throw an error, this limitation isn't clearly communicated in the current documentation.

This lack of clarity has led to misuse in several prominent projects, including:

By updating the documentation, we can help prevent similar misunderstandings and improve the developer experience when working with SvelteKit forms.


Please don't delete this checklist! 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
  • 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 pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Aug 4, 2024

⚠️ No Changeset found

Latest commit: 6d441f2

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

@garysassano garysassano changed the title Improve docs for use:enhance docs: clarify use:enhance compatibility with method="POST" Aug 4, 2024
@eltigerchino eltigerchino added the documentation Improvements or additions to documentation label Aug 6, 2024
Copy link
Member

@eltigerchino eltigerchino left a comment

Choose a reason for hiding this comment

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

Thank you! (and sorry this took so long)

@eltigerchino eltigerchino merged commit 793c00e into sveltejs:main Oct 9, 2024
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants