From 8fa212bcd0a7da84ba8346bd0ff69c951fea7395 Mon Sep 17 00:00:00 2001 From: meowmeowcat Date: Thu, 2 Sep 2021 17:23:35 +0800 Subject: [PATCH 1/3] Add backquotes for commands --- source/specifications/direct-url.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/source/specifications/direct-url.rst b/source/specifications/direct-url.rst index 7df786cae..6a75181a4 100644 --- a/source/specifications/direct-url.rst +++ b/source/specifications/direct-url.rst @@ -278,18 +278,18 @@ Example pip commands and their effect on direct_url.json Commands that generate a ``direct_url.json``: -* pip install https://example.com/app-1.0.tgz -* pip install https://example.com/app-1.0.whl -* pip install "git+https://example.com/repo/app.git#egg=app&subdirectory=setup" -* pip install ./app -* pip install file:///home/user/app -* pip install --editable "git+https://example.com/repo/app.git#egg=app&subdirectory=setup" +* ``pip install https://example.com/app-1.0.tgz`` +* ``pip install https://example.com/app-1.0.whl`` +* ``pip install "git+https://example.com/repo/app.git#egg=app&subdirectory=setup"`` +* ``pip install ./app`` +* ``pip install file:///home/user/app`` +* ``pip install --editable "git+https://example.com/repo/app.git#egg=app&subdirectory=setup"`` (in which case, ``url`` will be the local directory where the git repository has been cloned to, and ``dir_info`` will be present with ``"editable": true`` and no ``vcs_info`` will be set) -* pip install -e ./app +* ``pip install -e ./app`` Commands that *do not* generate a ``direct_url.json`` -* pip install app -* pip install app --no-index --find-links https://example.com/ +* ``pip install app`` +* ``pip install app --no-index --find-links https://example.com/`` From fd5900849ed07f99e10f9c129a4be1b4799619c8 Mon Sep 17 00:00:00 2001 From: meowmeowcat Date: Thu, 2 Sep 2021 21:26:11 +0800 Subject: [PATCH 2/3] Use `--editable`` instead of `-e` Co-authored-by: Brian Rutledge --- source/specifications/direct-url.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/specifications/direct-url.rst b/source/specifications/direct-url.rst index 6a75181a4..105653699 100644 --- a/source/specifications/direct-url.rst +++ b/source/specifications/direct-url.rst @@ -287,7 +287,7 @@ Commands that generate a ``direct_url.json``: (in which case, ``url`` will be the local directory where the git repository has been cloned to, and ``dir_info`` will be present with ``"editable": true`` and no ``vcs_info`` will be set) -* ``pip install -e ./app`` +* ``pip install --editable ./app`` Commands that *do not* generate a ``direct_url.json`` From ae43f328fd11de43c8385bf37ca5ee6bc68f4631 Mon Sep 17 00:00:00 2001 From: meowmeowcat <68463158+meowmeowmeowcat@users.noreply.github.com> Date: Fri, 3 Sep 2021 18:27:53 +0800 Subject: [PATCH 3/3] Revert "Use `--editable`` instead of `-e`" This reverts commit fd5900849ed07f99e10f9c129a4be1b4799619c8. --- source/specifications/direct-url.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/specifications/direct-url.rst b/source/specifications/direct-url.rst index 105653699..6a75181a4 100644 --- a/source/specifications/direct-url.rst +++ b/source/specifications/direct-url.rst @@ -287,7 +287,7 @@ Commands that generate a ``direct_url.json``: (in which case, ``url`` will be the local directory where the git repository has been cloned to, and ``dir_info`` will be present with ``"editable": true`` and no ``vcs_info`` will be set) -* ``pip install --editable ./app`` +* ``pip install -e ./app`` Commands that *do not* generate a ``direct_url.json``