Skip to content

Commit a72c2c4

Browse files
committed
docs(develop): use double quotes for pip
Some shells, notably Zsh, try parsing the brackets. Fixes: #910
1 parent 29d3d64 commit a72c2c4

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ If you know what you're doing and have developed for Python projects in the past
4343
4. If using a virtual environment instead of a dependency manager, install an editable version of the program and development dependencies with the following PIP command:
4444
4545
```
46-
pip install -e .[dev]
46+
pip install -e ".[dev]"
4747
```
4848
4949
Otherwise, modify the command above for use with your dependency manager of choice. For example if using uv, you may use this:
5050
5151
```
52-
uv pip install -e .[dev]
52+
uv pip install -e ".[dev]"
5353
```
5454
5555
## Workflow Checks

docs/develop.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To install the required dependencies, you can use a dependency manager such as [
4141
If using [uv](https://docs.astral.sh/uv), you can install the dependencies for TagStudio with the following command:
4242

4343
```sh
44-
uv pip install -e .[dev]
44+
uv pip install -e ".[dev]"
4545
```
4646

4747
A reference `.envrc` is provided for use with [direnv](#direnv), see [`contrib/.envrc-uv`](https://github.com/TagStudioDev/TagStudio/blob/main/contrib/.envrc-uv).
@@ -92,7 +92,7 @@ If you choose to manually set up a virtual environment and install dependencies
9292
3. Use the following PIP command to create an editable installation and install the required development dependencies:
9393

9494
```sh
95-
pip install -e .[dev]
95+
pip install -e ".[dev]"
9696
```
9797

9898
## Nix(OS)

docs/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ pip install .
4646
!!! note "Developer Dependencies"
4747
If you wish to create an editable install with the additional dependencies required for developing TagStudio, use this modified PIP command instead:
4848
```sh
49-
pip install -e .[dev]
49+
pip install -e ".[dev]"
5050
```
5151
_See more under "[Developing](./develop.md)"_
5252

0 commit comments

Comments
 (0)