christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 14:17:46 +00:00
Code Issues Releases Activity

docs: wrap tutor[full] in quotes for zsh compatibility

Browse Source 
The docs recommend commands like:

    pip install tutor[full]
    pip install -e ./tutor[full]

for installing Tutor. These work fine in bash. For zsh,
though, which is now the default on macOS, quotes are
needed, otherwise zsh will interpret the brackets as
special syntax:

    pip install "tutor[full]"
    pip install -e "./tutor[full]"

Caveat: I have not tested this myself since I don't
own a Mac, but I've read several issue reports to this
effect, such as:
https://github.com/pypa/pipenv/issues/2830#issuecomment-419593199
This commit is contained in:
Kyle McCormick 2022-04-06 10:23:25 -04:00 committed by Régis Behmo
parent 3ca4522f68
commit 5f4159c030
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/_release_description.md
View File

@ -1,6 +1,6 @@
Install this version from pip with:: Install this version from pip with::
pip install tutor[full]==TUTOR_VERSION pip install "tutor[full]==TUTOR_VERSION"
Or download the compiled binaries:: Or download the compiled binaries::

2
docs/download/pip.rst
View File

@ -1,3 +1,3 @@
.. parsed-literal:: .. parsed-literal::
pip install tutor[full] pip install "tutor[full]"

2
docs/install.rst
View File

@ -89,7 +89,7 @@ Upgrading
To upgrade Open edX or benefit from the latest features and bug fixes, you should simply upgrade Tutor. Start by upgrading the "tutor" package and its dependencies:: To upgrade Open edX or benefit from the latest features and bug fixes, you should simply upgrade Tutor. Start by upgrading the "tutor" package and its dependencies::
pip install --upgrade tutor[full] pip install --upgrade "tutor[full]"
Then run the ``quickstart`` command again. Depending on your deployment target, run either:: Then run the ``quickstart`` command again. Depending on your deployment target, run either::