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

fix: truncated comment when running create-svelte #11788

Merged
merged 2 commits into from
Mar 15, 2024

Conversation

owenversteeg
Copy link
Contributor

@owenversteeg owenversteeg commented Feb 2, 2024

When running create-svelte, I noticed that the Typescript generated project had a comment truncated compared to an identical JSDoc generated project. I've added the truncated portion as there's no indication that this was intention in the original commit, 9b24b9c. I've included a screenshot of that commit to make it clear (you can see how the jsconfig has both links, but the tsconfig has only the one.)

Screenshot 2024-02-02 at 1 43 26 PM

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 Feb 2, 2024

🦋 Changeset detected

Latest commit: cc15210

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

This PR includes changesets to release 1 package
Name Type
create-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

@owenversteeg owenversteeg changed the title Fix truncated comment when running create-svelte fix: truncated comment when running create-svelte Feb 2, 2024
@benmccann benmccann added the documentation Improvements or additions to documentation label Feb 18, 2024
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 pkg:create-svelte
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants