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.

Sign up for GitHub

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

Jump to bottom

docs: emphasise $app/state objects are read-only #13236

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: emphasise $app/state objects are read-only #13236

wants to merge 1 commit into from
+7 −7

Conversation

eltigerchino
Copy link
Member

closes #13229

This PR adds the "read-only" keyword in the description of each $app/state export to emphasise its immutability.

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.

@eltigerchino eltigerchino added the documentation Improvements or additions to documentation label Dec 24, 2024
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Dec 24, 2024

⚠️ No Changeset found

Latest commit: 05dc28d

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

@eltigerchino eltigerchino changed the title docs: emphasise $app/state objects are read-only docs: emphasise $app/state objects are read-only Dec 24, 2024
@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-kit-13236-svelte.vercel.app/

this is an automated message

@benmccann
Copy link
Member

documentation/docs/98-reference/20-$app-state.md has "readonly". I wonder if we should go with the non-hyphenated version for consistency?

@eltigerchino
Copy link
Member Author

documentation/docs/98-reference/20-$app-state.md has "readonly". I wonder if we should go with the non-hyphenated version for consistency?

I've changed that too to spell "read-only". Found this while searching for read-only vs readonly https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/r/read-only

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Documentation] $app-state#page immutable but not documented
3 participants
@eltigerchino @Rich-Harris @benmccann