Skip to content

fix: small legibility improvement #12928

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 4 commits into from
Aug 20, 2024
Merged

Conversation

GauBen
Copy link
Contributor

@GauBen GauBen commented Aug 20, 2024

Minimal update to slightly improve the legibility of the hint, because " is displayed as \"

Before:

image

After:

image


While we're at it, we may provide a copy-pasteable hint:

{
	'Function passed to {@render ...} tag must be of type Snippet': "import type { Snippet } from 'svelte'";
} & typeof SnippetReturn
  • Swapped hint and symbol so that the hint is displayed first
  • Replaced _ key with "problem": "solution" structure
  • Made a copy-pasteable solution

It renders as:

image

What do you think of this?

It's not possible to make a multi-line hint, as new lines are displayed as \n.


Svelte 5 rewrite

Please note that the Svelte codebase is currently being rewritten for Svelte 5. Changes should target Svelte 5, which lives on the default branch (main).

If your PR concerns Svelte 4 (including updates to svelte.dev.docs), please ensure the base branch is svelte-4 and not main.

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 and linting

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

Copy link

changeset-bot bot commented Aug 20, 2024

🦋 Changeset detected

Latest commit: 090600b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
svelte Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@Rich-Harris
Copy link
Member

Thanks! Yeah, I like those additional suggestions. I think we can iterate on the wording too to make it more concise – how about this?

{ "{@render ...} must be called with a Snippet": "import type { Snippet } from 'svelte'" }

@GauBen
Copy link
Contributor Author

GauBen commented Aug 20, 2024

It's even better! I just pushed the change

@Rich-Harris Rich-Harris merged commit f6f0e78 into sveltejs:main Aug 20, 2024
9 checks passed
@Rich-Harris
Copy link
Member

thank you!

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