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

Document the utils module and reference it in the randomization docs #3128

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

Conversation

bjoluc
Copy link
Member

@bjoluc bjoluc commented Sep 12, 2023

Adds a Reference > jsPsych.utils documentation page. To do: Reference deepCopy in the randomization docs to resolve #2808. I'm not quite sure where. @ChristopheBossens @jspsych/core Any suggestions?

@changeset-bot
Copy link

changeset-bot bot commented Sep 12, 2023

⚠️ No Changeset found

Latest commit: 36e64ef

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

@ChristopheBossens
Copy link

Adds a Reference > jsPsych.utils documentation page. To do: Reference deepCopy in the randomization docs to resolve #2808. I'm not quite sure where. @ChristopheBossens @jspsych/core Any suggestions?

I have not checked but I think the issue with #2808 could also arise using e.g., the randomization.repeat function? I first thought a general reference at the top of the docs should work. But I think a lot of people might just read the parameters list of the respective function they want to use and miss that. Maybe add a small disclaimer to array parameter description for the relevant functions (e.g., "if your array contains arrays, consider if a deepCopy is necessary")?

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.

jsPsych.randomization.shuffle does not return a deep copy
2 participants