From adbd99a1d60d4772436be5777c94953b9072a49a Mon Sep 17 00:00:00 2001
From: Charlie Marsh <charlie.r.marsh@gmail.com>
Date: Tue, 17 Sep 2024 15:19:45 -0400
Subject: [PATCH] Document `store_credentials_from_workspace` (#7477)

---
 crates/uv/src/commands/project/sync.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/crates/uv/src/commands/project/sync.rs b/crates/uv/src/commands/project/sync.rs
index 97d3c025f..af46bfeb1 100644
--- a/crates/uv/src/commands/project/sync.rs
+++ b/crates/uv/src/commands/project/sync.rs
@@ -406,6 +406,12 @@ fn apply_editable_mode(
     }
 }
 
+/// Extract any credentials that are defined on the workspace dependencies themselves. While we
+/// don't store plaintext credentials in the `uv.lock`, we do respect credentials that are defined
+/// in the `pyproject.toml`.
+///
+/// These credentials can come from any of `tool.uv.sources`, `tool.uv.dev-dependencies`,
+/// `project.dependencies`, and `project.optional-dependencies`.
 fn store_credentials_from_workspace(workspace: &Workspace) {
     for member in workspace.packages().values() {
         // Iterate over the `tool.uv.sources`.