Skip to content

CONTRIBUTING: Make virtualenv dir name consistent with gitignore - #835

Merged
asottile merged 1 commit into
PyCQA:masterfrom
EricCousineau-TRI:feature/venv_doc_consistency
Feb 19, 2020
Merged

CONTRIBUTING: Make virtualenv dir name consistent with gitignore#835
asottile merged 1 commit into
PyCQA:masterfrom
EricCousineau-TRI:feature/venv_doc_consistency

Conversation

@EricCousineau-TRI

Copy link
Copy Markdown
Contributor

Had noticed this while doing #834.

Comment thread CONTRIBUTING.rst Outdated
$ virtualenv venv
$ source venv/bin/activate

Note that ``venv/`` is ignored via ``.gitignore``.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. (Would still be nice to call out gitignore, 'cause that's the first thing I'll look at when generating auxiliary artifacts.)

@EricCousineau-TRI
EricCousineau-TRI force-pushed the feature/venv_doc_consistency branch from 70d9813 to 84da6f3 Compare January 30, 2019 17:31

@asottile asottile left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread .gitignore
docs/_build
build/
venv/
/venv*/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the leading slash correct here? Should it just be venv*/ This isn't a regular expression, it's a glob (I thought)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".

@EricCousineau-TRI

Copy link
Copy Markdown
Contributor Author

Er, and is there an easy way to retrigger Travis? Or should I just close + reopen the PR?
The failures in CPython3.5 + PyPy3.5 seem like download flakes?

@sigmavirus24

Copy link
Copy Markdown
Member

The failures in CPython3.5 + PyPy3.5 seem like download flakes?

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.

@asottile
asottile merged commit 68cc24f into PyCQA:master Feb 19, 2020
@asottile

Copy link
Copy Markdown
Member

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants