Skip to content

docs: state platform support (Linux/macOS/Windows)#238

Open
dimitri-yatsenko wants to merge 1 commit into
mainfrom
docs/platform-support-statement
Open

docs: state platform support (Linux/macOS/Windows)#238
dimitri-yatsenko wants to merge 1 commit into
mainfrom
docs/platform-support-statement

Conversation

@dimitri-yatsenko

Copy link
Copy Markdown
Member

⚠️ Do not merge until datajoint-python #1521 and #1522 land. This documents Windows as a CI-backed supported platform; the claim about the Windows unit-test leg is only accurate once #1522 (the unit-tests-windows job) merges, and the underlying file-path fix is #1521.

Records the decision to keep Windows a supported platform for DataJoint — including file-protocol object stores and garbage collection — backed by CI, rather than documenting it as unsupported. Consistent with the existing "supported == what we test in CI" framing (the DB version-support policy in database-backends.md, from #1497).

Change

Adds a Platform support section to how-to/installation.md (plus a Requirements line), stating what CI validates on each OS:

  • Full suite incl. DB integration on Linux (Python 3.10 & 3.14).
  • Unit suite additionally on Windows (Python 3.10 & 3.14) — covering file-protocol path handling and garbage collection (the class of bug in datajoint-python #1520).
  • macOS as a supported development platform.

Wording is deliberately precise about what runs where so it doesn't overclaim (Windows runs the unit suite, not the DB-backed integration tests).

Related

  • datajoint-python #1520 (bug), #1521 (fix), #1522 (Windows CI leg).

Records the decision that Windows is a supported platform for datajoint,
including file-protocol object stores and garbage collection, backed by CI.
Adds a Platform support section describing what CI validates on each OS,
mirroring the DB version-support-policy tone in database-backends.md.

Depends on datajoint-python #1521 (path fix) + #1522 (Windows CI leg).
@dimitri-yatsenko dimitri-yatsenko added the documentation Improvements or additions to documentation label Jul 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant