Skip to content

Commit

Permalink
Merge pull request #28 from prompt-security/update_doc_for_zsh
Browse files Browse the repository at this point in the history
Update 'pip install -e' command in documentation to add double quotes, so it also works under zsh and on macosx, not only on bash/sh shells
  • Loading branch information
vitaly-ps authored Apr 16, 2024
2 parents cfa3bd8 + 706d5d6 commit 8c342af
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[dev] # Install package in editable mode with dev dependencies
pip install -e ".[dev]"" # Install package in editable mode with dev dependencies
- name: Run tests
run: |
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Install the project dependencies in editable mode (with the '-e' argument).
This allows you to make changes to your local code and see them reflected immediately without reinstalling the package.

```bash
pip install -e .[dev]
pip install -e ".[dev]"
```

### Run tests
Expand Down Expand Up @@ -68,7 +68,7 @@ The tool would automatically recognize that the file is present and will try to
### Running the Tool

To run the tool from your development environment, you can use the command-line interface set up in the project.
Since the package is installed in editable mode (e.g. via `pip install -e .[dev]`), you can run the tool directly from the source code without
Since the package is installed in editable mode (e.g. via `pip install -e ".[dev]"`), you can run the tool directly from the source code without
needing a separate installation step for testing changes.

To execute the tool, use the following command:
Expand Down

0 comments on commit 8c342af

Please sign in to comment.