matrix-org / matrix-org/matrix-spec

check_examples.py doesn't run on windows

Open
#330 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Tools
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Line numbers don't match up perfectly, but:

Checking response schema for: '.\\client-server\\device_management.yaml' 'GET /devices' 200
Loading reference: file://C:\redacted\path\matrix-doc\api\client-server\device_management.yaml/definitions/client_device.yaml
Traceback (most recent call last):
  File "./check_examples.py", line 147, in <module>
    raise ValueError("Error checking file %r" % (path,), e)
ValueError: ("Error checking file '.\\\\client-server\\\\device_management.yaml'", ValueError("Error validating JSON schema for 'GET /devices' 200", RefResolutionError(Exception('Bad ref: file://C:\\redacted\\path\\matrix-doc\\api\\client-server\\device_management.yaml/definitions/client_device.yaml',),)))

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with check_examples.py around line 147 and trace how the Windows path in the reported RefResolutionError is constructed. Reproduce the schema check on Windows using the example path from the report, then verify that the reference resolves and validation completes successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.