document lockfile limitations (#721)

* docs: document lockfile limitations * Update docs/guide/sync.md Co-authored-by: Jo <[email protected]> --------- Co-authored-by: Armin Ronacher <[email protected]> Co-authored-by: Jo <[email protected]>
astral-sh · Feb 21, 2024 · 299b491 · 299b491
1 parent 3209a6e
commit 299b491
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/guide/sync.md b/docs/guide/sync.md
@@ -99,3 +99,12 @@ lockfile (`requirements-dev.lock`).
 ```
 rye sync --no-dev
 ```
+
+## Limitations
+
+Lockfiles depend on the platform they were generated on. This is a known limitation
+in pip-tools.
+
+For example, if your project relies on platform-specific packages and you generate
+lockfiles on Windows, these lockfiles will include Windows-specific projects.
+Consequently, they won't be compatible with other platforms like Linux or macOS.