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: warn about impure force functions #3745

Closed
wants to merge 1 commit into from
Closed

docs: warn about impure force functions #3745

wants to merge 1 commit into from

Conversation

hamirmahal
Copy link
Contributor

fixes #3744.

@mbostock
Copy link
Member

Good idea. I think we should use a warning block, like this:

Screenshot 2023-08-21 at 11 10 17 AM

And we should add a similar warning for d3.forceLink, since that likewise can mutate links.

@hamirmahal hamirmahal changed the title docs: warn about impure forceSimulation(nodes) function docs: warn about impure force functions Aug 21, 2023
@hamirmahal hamirmahal mentioned this pull request Aug 21, 2023
Closed
@hamirmahal
Copy link
Contributor Author

Okay, let me know if there are other changes you'd like to see before merging this.

@mbostock
Copy link
Member

Sorry, I should have mentioned I started a branch with some wording changes too. I’ll get this merged. Thank you. 👍

@mbostock
Copy link
Member

Folded into #3755.

@mbostock mbostock closed this Aug 21, 2023
@hamirmahal hamirmahal deleted the patch-1 branch August 21, 2023 19:39
@hamirmahal
Copy link
Contributor Author

You're welcome! Thanks for merging this into your branch.

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
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

warn about impure forceSimulation(nodes) function that can modify its input
2 participants
@hamirmahal @mbostock