Skip to content

Commit c66df88

Browse files
authored
changed "pip install .[dev]" to include -e option since both it and "pip install ." install the package in site-libs but in different ways (#203)
1 parent 18903f2 commit c66df88

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

docs/practices/precommit.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Pre-Commit
44
What is it? Why do it?
55
-------------------------------------------------------------------------------
66

7-
``pre-commit`` is installed when running ``pip install '.[dev]'``. It's an industry
7+
``pre-commit`` is installed when running ``pip install -e '.[dev]'``. It's an industry
88
standard tool that executes a set of tests prior to completing a ``git commit`` action.
99
Using pre-commit enables a quick check of your code before it's committed and checked
1010
by GitHub workflows. This cuts down on code feedback time, and allows for faster
@@ -58,4 +58,4 @@ of these that are not useful for your project.
5858

5959

6060
Many other pre-commit hooks exist, a partial list can be found in the pre-commit
61-
`documentation <https://pre-commit.com/hooks.html>`_.
61+
`documentation <https://pre-commit.com/hooks.html>`_.

docs/source/existing_project.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ or missing dependencies.
155155
.. code:: bash
156156
157157
>> pip install -e .
158-
>> pip install .'[dev]'
158+
>> pip install -e .'[dev]'
159159
160160
.. note::
161161

docs/source/new_project.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Use ``pip`` to install both the standard set of dependencies as well as the
9191
Lots of output
9292
...
9393
94-
>> pip install '.[dev]'
94+
>> pip install -e '.[dev]'
9595
...
9696
Lots more output
9797
...
@@ -144,4 +144,4 @@ Run the following command in your terminal.
144144
>> pre-commit install
145145
146146
For more information about ``pre-commit`` including a list of the checks that
147-
will be run before each commit, please see :doc:`pre-commit <../practices/precommit>`.
147+
will be run before each commit, please see :doc:`pre-commit <../practices/precommit>`.

0 commit comments

Comments
 (0)