From ca62f8855bb1fdbc29494609ef3cc6477fd8dc43 Mon Sep 17 00:00:00 2001
From: Volker Hilsenstein <2210044+VolkerH@users.noreply.github.com>
Date: Fri, 4 Oct 2024 12:42:18 +0200
Subject: [PATCH] Fix documentation (projects guide) regarding adding a git
 dependency (#7916)

## Summary

This is a trivial, one line documentation change that fixes the
following documentation bug.

The current documentation suggests this for adding a git dependency

```
# Add a git dependency

uv add requests --git https://github.com/psf/requests
```

Executing what is suggested with `uv` version `0.4.18` results in this
error message

```
uv add requests --git https://github.com/psf/requests
error: unexpected argument '--git' found
```

The working approach is to add the git depency like this:

```
uv add git+https://github.com/psf/requests
```

## Test Plan

I manually tested the command suggested currently in the guide against
my change.
---
 docs/guides/projects.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/guides/projects.md b/docs/guides/projects.md
index 29b8f94d9..3cb75509d 100644
--- a/docs/guides/projects.md
+++ b/docs/guides/projects.md
@@ -124,7 +124,7 @@ $ # Specify a version constraint
 $ uv add 'requests==2.31.0'
 
 $ # Add a git dependency
-$ uv add requests --git https://github.com/psf/requests
+$ uv add git+https://github.com/psf/requests
 ```
 
 To remove a package, you can use `uv remove`: