diff --git a/docs/advanced.rst b/docs/advanced.rst index 31abcc9f67..19f383771e 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -70,10 +70,7 @@ Luckily - pipenv will hash your Pipfile *before* expanding environment variables (and, helpfully, will substitute the environment variables again when you install from the lock file - so no need to commit any secrets! Woo!) -If your credentials contain a special character, surround the references to the environment variables with quotation marks. For example, if your password contain a double quotation mark, surround the password variable with single quotation marks. Otherwise, you may get a ``ValueError, "No closing quotation"`` error while installing dependencies. :: - - [[source]] - url = "https://$USERNAME:'${PASSWORD}'@mypypi.example.com/simple" +If your credentials contain special characters, make sure they are URL-encoded as specified in `rfc3986 `_. Environment variables may be specified as ``${MY_ENVAR}`` or ``$MY_ENVAR``. diff --git a/news/4856.doc.rst b/news/4856.doc.rst new file mode 100644 index 0000000000..d994f5852f --- /dev/null +++ b/news/4856.doc.rst @@ -0,0 +1 @@ +Fix the documentation to reflect the fact that special characters must be percent-encoded in the URL.