Skip to content

Commit 354d92f

Browse files
committed
Update Development Getting Started guide to reflect reality
- The VCS tests are automatically skipped. The phrasing in the guide stated otherwise. - Recommend using `.venv` as the folder name for the virtual environment for development.
1 parent 28e794e commit 354d92f

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/html/development/getting-started.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,17 @@ You can then invoke your local source tree pip normally.
4242

4343
.. code-block:: shell
4444
45-
virtualenv venv # You can also use "python -m venv venv" from python3.3+
46-
source venv/bin/activate
45+
python -m venv .venv
46+
source .venv/bin/activate
4747
python -m pip install -e .
4848
python -m pip --version
4949
5050
.. tab:: Windows
5151

5252
.. code-block:: shell
5353
54-
virtualenv venv # You can also use "py -m venv venv" from python3.3+
55-
venv\Scripts\activate
54+
py -m venv .venv
55+
.venv\Scripts\activate
5656
py -m pip install -e .
5757
py -m pip --version
5858
@@ -94,9 +94,10 @@ can select tests using the various ways that pytest provides:
9494
$ # Using keywords
9595
$ tox -e py36 -- -k "install and not wheel"
9696
97-
Running pip's test suite requires supported version control tools (subversion,
98-
bazaar, git, and mercurial) to be installed. If you are missing one of the VCS
99-
tools, you can tell pip to skip those tests:
97+
Running pip's entire test suite requires supported version control tools
98+
(subversion, bazaar, git, and mercurial) to be installed. If you are missing
99+
any of these VCS, those tests should be skipped automatically. You can also
100+
explicitly tell pytest to skip those tests:
100101

101102
.. code-block:: console
102103

0 commit comments

Comments
 (0)