Fix venv command examples #2560
Conversation
The documentation refers to `venv`, which is native to Python3. However, the command examples are as if they were still `virtualenv`, which is a package independent of `venv`: - It doesn't need to be installed via `pip`. In fact `pip install venv` would return an error. - The correct way to invoke `venv` is `python3 -m venv`, not `venv`, which would return command not found. See https://docs.python.org/3/library/venv.html I suspect the documentation simply replaced all occurrences of `virtualenv` with `venv`. However they are different modules and are used differently.
|
Hi @x-ji, thanks for your pull request! 👍 It looks like you haven't filled in the spaCy Contributor Agreement (SCA) yet. The agrement ensures that we can use your contribution across the project. Once you've filled in the template, put it in the If you've already included the Contributor Agreement in your pull request above, you can ignore this message. |
|
Eh I think I put it in here already?: https://github.com/explosion/spaCy/pull/2560/files#diff-593d0bd81635de6489438e03e51181ce |
|
Thanks a lot, really appreciate the attention to detail! I'm pretty sure that's what happened and we just didn't adjust the commands correctly. In general, we definitely want to standardise on Python 3, but provide fallbacks for Python 2-specific stuff for users who are still working on older code bases.
Yes, that's all good! 👍 Sorry, our bot isn't very clever. It's currently only checking the existing repo and not the files included in the PR, because that ended up being tricky to get right. (I might look into this again, though!) |
* Fix venv command examples The documentation refers to `venv`, which is native to Python3. However, the command examples are as if they were still `virtualenv`, which is a package independent of `venv`: - It doesn't need to be installed via `pip`. In fact `pip install venv` would return an error. - The correct way to invoke `venv` is `python3 -m venv`, not `venv`, which would return command not found. See https://docs.python.org/3/library/venv.html I suspect the documentation simply replaced all occurrences of `virtualenv` with `venv`. However they are different modules and are used differently. * Update comment [ci skip]
Description
The documentation refers to
venv, which is native to Python3. However, the command examples are as if they were still usingvirtualenv, which is a package independent ofvenv:venvdoesn't need to be installed viapip. In factpip install venvwouldreturn an error.
venvispython3 -m venv, notvenv, which wouldreturn command not found.
See https://docs.python.org/3/library/venv.html
I suspect that at some point the documentation simply replaced all occurrences of
virtualenvwithvenv. However they are different modules and are used differently. The documentation should either stick withvirtualenvor correctly usevenv, which is what this PR tries to do.Types of change
Change to the documentation.
Checklist
(I'm not sure what "or if they do, I've added all required information." refers to. I have documented why I feel it necessary to change the relevant commands in the documentation.)