Skip to content

Commit

Permalink
changed "pip install .[dev]" to include -e option since both it and "…
Browse files Browse the repository at this point in the history
…pip install ." install the package in site-libs but in different ways (#203)
  • Loading branch information
cchris28 authored Jun 1, 2023
1 parent 18903f2 commit c66df88
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/practices/precommit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Pre-Commit
What is it? Why do it?
-------------------------------------------------------------------------------

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


Many other pre-commit hooks exist, a partial list can be found in the pre-commit
`documentation <https://pre-commit.com/hooks.html>`_.
`documentation <https://pre-commit.com/hooks.html>`_.
2 changes: 1 addition & 1 deletion docs/source/existing_project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ or missing dependencies.
.. code:: bash
>> pip install -e .
>> pip install .'[dev]'
>> pip install -e .'[dev]'
.. note::

Expand Down
4 changes: 2 additions & 2 deletions docs/source/new_project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Use ``pip`` to install both the standard set of dependencies as well as the
Lots of output
...
>> pip install '.[dev]'
>> pip install -e '.[dev]'
...
Lots more output
...
Expand Down Expand Up @@ -144,4 +144,4 @@ Run the following command in your terminal.
>> pre-commit install
For more information about ``pre-commit`` including a list of the checks that
will be run before each commit, please see :doc:`pre-commit <../practices/precommit>`.
will be run before each commit, please see :doc:`pre-commit <../practices/precommit>`.

0 comments on commit c66df88

Please sign in to comment.