From a72c2c4ba89a92e2d38e3bed3c60d49aab182113 Mon Sep 17 00:00:00 2001 From: Xarvex Date: Sat, 5 Apr 2025 19:11:40 -0500 Subject: [PATCH] docs(develop): use double quotes for pip Some shells, notably Zsh, try parsing the brackets. Fixes: #910 --- CONTRIBUTING.md | 4 ++-- docs/develop.md | 4 ++-- docs/install.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ad19446..d3b0dac2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,13 +43,13 @@ If you know what you're doing and have developed for Python projects in the past 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: ``` - pip install -e .[dev] + pip install -e ".[dev]" ``` Otherwise, modify the command above for use with your dependency manager of choice. For example if using uv, you may use this: ``` - uv pip install -e .[dev] + uv pip install -e ".[dev]" ``` ## Workflow Checks diff --git a/docs/develop.md b/docs/develop.md index e023fef9..0d0e2562 100644 --- a/docs/develop.md +++ b/docs/develop.md @@ -41,7 +41,7 @@ To install the required dependencies, you can use a dependency manager such as [ If using [uv](https://docs.astral.sh/uv), you can install the dependencies for TagStudio with the following command: ```sh -uv pip install -e .[dev] +uv pip install -e ".[dev]" ``` 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 3. Use the following PIP command to create an editable installation and install the required development dependencies: ```sh - pip install -e .[dev] + pip install -e ".[dev]" ``` ## Nix(OS) diff --git a/docs/install.md b/docs/install.md index 1ae380ae..0add6e1a 100644 --- a/docs/install.md +++ b/docs/install.md @@ -46,7 +46,7 @@ pip install . !!! note "Developer Dependencies" If you wish to create an editable install with the additional dependencies required for developing TagStudio, use this modified PIP command instead: ```sh - pip install -e .[dev] + pip install -e ".[dev]" ``` _See more under "[Developing](./develop.md)"_