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

chore: document init parameters #9118

Merged
merged 1 commit into from
Sep 20, 2023
Merged

Conversation

gtm-nayan
Copy link
Contributor

closes #7200

The internal types aren't exposed as a public API and shouldn't be relied on but figured it'd be nice to document these anyway just so no one forgets what these are when we context switch to the next major

A few left to do still as I couldn't quite describe them, feel free to make suggestions as review comments or push

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

@changeset-bot
Copy link

changeset-bot bot commented Aug 19, 2023

⚠️ No Changeset found

Latest commit: ff9f000

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

@benmccann
Copy link
Member

it'd be nice to document these anyway just so no one forgets what these are when we context switch to the next major

will we need to remember what they are once we stop working on this codebase?

@dummdidumm dummdidumm merged commit 3191147 into master Sep 20, 2023
6 checks passed
@dummdidumm dummdidumm deleted the chore-init-params-documentation branch September 20, 2023 07:59
kelvinsjk pushed a commit to kelvinsjk/svelte that referenced this pull request Oct 19, 2023
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.

append_styles s/b typed as an optional parameter in function init(...)
3 participants