docs: fix stale references to the jsPsych core multiplayer API - #70
Open
htsukamoto5 wants to merge 1 commit into
Open
docs: fix stale references to the jsPsych core multiplayer API#70htsukamoto5 wants to merge 1 commit into
htsukamoto5 wants to merge 1 commit into
Conversation
Two stale pointers to jsPsych#3694, verified against that PR head today. The vendored `multiplayer-adapter.ts` mirror in all three adapters cited the core types as living at `packages/jspsych/src/modules/plugin-api/MultiplayerAPI.ts`. The real path is `packages/jspsych/src/modules/multiplayer/index.ts`. That comment calls itself "the single seam to re-verify once #3694 lands", so it is the one pointer that has to resolve. The local adapter's 0.1.0 changelog entry showed the pre-namespace-migration `pluginAPI.connect(...)` form; the API is `jsPsych.multiplayer.connect(...)`. Comments and docs only — no behavior change, interface shape unchanged. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two stale pointers to jsPsych#3694, found while verifying the core API against that PR's head today.
1. The vendored adapter-contract mirror pointed at a nonexistent file. All three adapters carry a local
src/multiplayer-adapter.tscopy of the contract, whose header cites the core types as living atpackages/jspsych/src/modules/plugin-api/MultiplayerAPI.ts. The real path on the PR head ispackages/jspsych/src/modules/multiplayer/index.ts. That comment describes itself as "the single seam to re-verify once #3694 lands", so it is the one pointer in the repo that has to resolve.2. The local adapter's 0.1.0 changelog entry showed the pre-namespace-migration
pluginAPI.connect(new LocalAdapter()); the API isjsPsych.multiplayer.connect(...). This is a published changelog entry, so it is visible on npm.While verifying, I also re-checked the interface shape and the composed operations against the PR head:
MultiplayerAdapteris identical to the vendored mirrors, andupdate/waitbehave as the READMEs and docs site describe (shallow own-slot merge then push, non-atomic against itself;waitis subscribe-based with replay-as-fast-path, rejects on a throwing predicate, and rejects with a typedMultiplayerTimeoutError). No other drift found — the docs site and package READMEs were already correct.Comments and docs only. No behavior change, no interface change; prettier clean.
🤖 Generated with Claude Code