From 4514c0cab3abdfad901a1fd5dfe26a8682957ded Mon Sep 17 00:00:00 2001 From: David Beitey Date: Mon, 11 Feb 2019 06:54:40 +0000 Subject: [PATCH] Docs: clarify quoting in version specs note Previously it was confusing as to what `" "` meant exactly -- I read it as a whitespace character was needed somewhere when it's referring to the double quote characters. --- docs/basics.rst | 2 +- news/3522.doc.rst | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 news/3522.doc.rst diff --git a/docs/basics.rst b/docs/basics.rst index 00f4c7d9..7dddcfc3 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -203,7 +203,7 @@ To make inclusive or exclusive version comparisons you can use: :: $ pipenv install "requests<=2.13" # will install a version equal or lower than 2.13.0 $ pipenv install "requests>2.19" # will install 2.19.1 but not 2.19.0 -.. note:: The use of ``" "`` around the package and version specification is highly recommended +.. note:: The use of double quotes around the package and version specification (i.e. ``"requests>2.19"``) is highly recommended to avoid issues with `Input and output redirection `_ in Unix-based operating systems. diff --git a/news/3522.doc.rst b/news/3522.doc.rst new file mode 100644 index 00000000..3d71061f --- /dev/null +++ b/news/3522.doc.rst @@ -0,0 +1 @@ +Clarify wording in Basic Usage example on using double quotes to escape shell redirection