CONTRIBUTING: Make virtualenv dir name consistent with gitignore #835
Conversation
CONTRIBUTING.rst
Outdated
| $ virtualenv venv | ||
| $ source venv/bin/activate | ||
|
|
||
| Note that ``venv/`` is ignored via ``.gitignore``. |
There was a problem hiding this comment.
so I assume that the original author intended for the project name to be in the venv name so it would show up in the PS1 -- I think we can make both work with something this:
in .gitignore
/venv*
in docs
suggest venv-pycodestyle
(and it'll also work for the common workflow of a venv just named venv or venv2 or venv3)
There was a problem hiding this comment.
Done. (Would still be nice to call out gitignore, 'cause that's the first thing I'll look at when generating auxiliary artifacts.)
Update gitignore to be more flexible
EricCousineau-TRI
force-pushed
the
feature/venv_doc_consistency
branch
from
70d9813 to
84da6f3
Compare
| docs/_build | ||
| build/ | ||
| venv/ | ||
| /venv*/ |
There was a problem hiding this comment.
Is the leading slash correct here? Should it just be venv*/ This isn't a regular expression, it's a glob (I thought)
There was a problem hiding this comment.
The leading slash in .gitignore implies that it should only match venv*/ directories that directly neighbor the .gitignore file.
e.g. it will ignore pycodestyle/venv-biscuit/, but not pycodestyle/docs/venv-cookie.
There was a problem hiding this comment.
Citing da sources:
https://git-scm.com/docs/gitignore#_pattern_format
A leading slash matches the beginning of the pathname. For example, "/*.c" matches "cat-file.c" but not "mozilla-sha1/sha1.c".
|
Er, and is there an easy way to retrigger Travis? Or should I just close + reopen the PR? |
I've triggered both to re-build. The CPython 3.5 build at the bottom, however, is for flake8. That one is likely not related to flakey tests. |
|
thanks! |
3 participants
Had noticed this while doing #834.