Document yanked packages caveat during sync (#6219)

Closes #5928
astral-sh · Aug 19, 2024 · df2ebf7 · df2ebf7
1 parent c410d0d
commit df2ebf7
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs
@@ -609,6 +609,9 @@ pub enum ProjectCommand {
     ///
     /// uv will search for a project in the current directory or any parent
     /// directory. If a project cannot be found, uv will exit with an error.
+    ///
+    /// Note that, when installing from a lockfile, uv will not provide warnings for yanked package
+    /// versions.
     #[command(
         after_help = "Use `uv help sync` for more details.",
         after_long_help = ""

diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -1007,6 +1007,8 @@ The project is re-locked before syncing unless the `--locked` or `--frozen` flag
 
 uv will search for a project in the current directory or any parent directory. If a project cannot be found, uv will exit with an error.
 
+Note that, when installing from a lockfile, uv will not provide warnings for yanked package versions.
+
 <h3 class="cli-reference">Usage</h3>
 
 ```