Extend the reference documentation for uv pip sync (#12683)

See https://github.com/astral-sh/uv/issues/12680
2025-04-07 17:40:26 -05:00
parent a0f5c7250b
commit 8ea34b56a1
2 changed files with 13 additions and 1 deletions
@@ -625,6 +625,14 @@ pub enum PipCommand {
    )]
    Compile(PipCompileArgs),
    /// Sync an environment with a `requirements.txt` file.
+    ///
+    /// When syncing an environment, any packages not listed in the `requirements.txt` file will
+    /// be removed. To retain extraneous packages, use `uv pip install` instead.
+    ///
+    /// The `requirements.txt` file is presumed to be the output of a `pip compile` or `uv export`
+    /// operation, in which it will include all transitive dependencies. If transitive dependencies
+    /// are not present in the file, they will not be installed. Use `--strict` to warn if any
+    /// transitive dependencies are missing.
    #[command(
        after_help = "Use `uv help pip sync` for more details.",
        after_long_help = ""