Merge pull request #835 from EricCousineau-TRI/feature/venv_doc_consi…

…stency CONTRIBUTING: Make virtualenv dir name consistent with gitignore
PyCQA · Feb 19, 2020 · 68cc24f · 68cc24f
2 parents 2796890 + 84da6f3
commit 68cc24f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,4 @@
 dist
 docs/_build
 build/
-venv/
+/venv*/
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -34,8 +34,10 @@ Next, ``cd`` to the pycodestyle repository that you cloned earlier and
 create, then activate a virtualenv::
 
     $ cd pycodestyle
-    $ virtualenv pycodestyle-venv
-    $ source pycodestyle-venv/bin/activate
+    $ virtualenv venv-pycodestyle
+    $ source venv-pycodestyle/bin/activate
+
+Note that ``venv*/`` is ignored via ``.gitignore``.
 
 Now you can install the pycodestyle requirements::
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,4 +5,4 @@ @@
     dist
     docs/_build
     build/
-    venv/
+    /venv*/