jsPsych icon indicating copy to clipboard operation
jsPsych copied to clipboard

Document the `utils` module and reference it in the randomization docs

Open bjoluc opened this issue 2 years ago • 2 comments

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?

bjoluc avatar Sep 12 '23 19:09 bjoluc

⚠️ No Changeset found

Latest commit: 36e64efbfb6a5c5df3e75b99d3be06cea4d221bc

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

changeset-bot[bot] avatar Sep 12 '23 19:09 changeset-bot[bot]

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")?

ChristopheBossens avatar Oct 02 '23 10:10 ChristopheBossens