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(signals): add explanation of mutable change protection to FAQ #4679

Closed
wants to merge 2 commits into from
Closed

docs(signals): add explanation of mutable change protection to FAQ #4679

wants to merge 2 commits into from

Conversation

rainerhahnekamp
Copy link
Contributor

Given the confusion around the need for immutable changes in Signals, it seems important to provide a more detailed explanation.

Adding this to the FAQ allows us to keep the main documentation concise and focused.

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

@netlify Netlify
Copy link

netlify bot commented Jan 18, 2025 •
edited
Loading

✅ Deploy Preview for ngrx-io ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 033fe07
🔍 Latest deploy log https://app.netlify.com/sites/ngrx-io/deploys/678edaa70ff70f0008cc4cba
😎 Deploy Preview https://deploy-preview-4679--ngrx-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

timdeschryver
timdeschryver reviewed Jan 20, 2025
View reviewed changes
Copy link
Member

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

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

Good idea to add this to the FAQ 👍

projects/ngrx.io/content/guide/signals/faq.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/signals/faq.md Show resolved Hide resolved
projects/ngrx.io/content/guide/signals/faq.md Show resolved Hide resolved
@rainerhahnekamp
docs(signals): add explanation of mutable change protection to FAQ
b0e6dc5 
Add a detailed explanation about freezing state and why it is necessary for
Signals. Includes examples illustrating the issues caused by mutable changes
and how to avoid them.
@rainerhahnekamp
docs(signals): use router as withProps example
033fe07
@rainerhahnekamp rainerhahnekamp force-pushed the docs/signals/immutability-protection branch from 9c604a7 to 033fe07 Compare January 20, 2025 23:22
timdeschryver
timdeschryver approved these changes Jan 24, 2025
View reviewed changes
Copy link
Member

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

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

LGTM 👍
I do wonder if we should wait to push this.

@rainerhahnekamp
Copy link
Contributor Author

Yeah, let's maybe wait 😅 or just close it unmerged.

@rainerhahnekamp
Copy link
Contributor Author

@timdeschryver, the RFC is out #4683. I don't think that there is then any need for this PR. What's your opinion?

@timdeschryver
Copy link
Member

@rainerhahnekamp lets close this PR and wait for the RFC result.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jits jits jits left review comments

@timdeschryver timdeschryver timdeschryver approved these changes

@markostanimirovic markostanimirovic Awaiting requested review from markostanimirovic

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rainerhahnekamp @timdeschryver @jits @markostanimirovic