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

v8 doc revision + expanding tutorials and ParameterType docs #3440

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

jadeddelta
Copy link
Collaborator

@jadeddelta jadeddelta commented Nov 20, 2024

hi all, this PR is just a simple documentation revision. this contains:

Copy link

changeset-bot bot commented Nov 20, 2024

⚠️ No Changeset found

Latest commit: cd7821d

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

Copy link
Member

@jodeleeuw jodeleeuw left a comment

Choose a reason for hiding this comment

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

This is awesome @jadeddelta. Some minor comments to address.

docs/developers/extension-development.md Outdated Show resolved Hide resolved
docs/developers/plugin-development.md Outdated Show resolved Hide resolved
docs/developers/plugin-development.md Outdated Show resolved Hide resolved
}
```

For more complicated scenarios, typically when handling data generated from an arbitrary function or user input, where we have a general idea of what data type it could produce, we may also specify multiple types of data. As an example, if we know we'll get either some number (integer or float) or a string from a field, we can specify it as such:
Copy link
Member

Choose a reason for hiding this comment

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

In this hypothetical case wouldn't the data just always be a string? When does this actually show up in the codebase?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this shows up primarily in the survey suite of plugins, where the data is specified as multiple types, but nowhere else. wondering if it's an issue with the implementation of survey as all data.response are sent as objects regardless of the type in the object, so something to look a bit deeper at

response: { // survey-html-form implementation
          type:
            ParameterType.STRING |
            ParameterType.INT |
            ParameterType.FLOAT |
            ParameterType.BOOL |
            ParameterType.OBJECT,
},

docs/reference/jspsych-pluginAPI.md Outdated Show resolved Hide resolved
docs/support/migration-v8.md Outdated Show resolved Hide resolved
docs/support/migration-v8.md Outdated Show resolved Hide resolved
docs/support/migration-v8.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants