From 88ac529219f8c1072a3c8e694d59dfa52a4a9f22 Mon Sep 17 00:00:00 2001 From: Qiming Xu <33349132+xqm32@users.noreply.github.com> Date: Tue, 28 Nov 2023 13:15:31 +0800 Subject: [PATCH 1/4] Fix outdated pip install argument description --- docs/html/cli/pip_install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/html/cli/pip_install.rst b/docs/html/cli/pip_install.rst index 951dc2705a3..5569a49c92a 100644 --- a/docs/html/cli/pip_install.rst +++ b/docs/html/cli/pip_install.rst @@ -45,7 +45,7 @@ When looking at the items to be installed, pip checks what type of item each is, in the following order: 1. Project or archive URL. -2. Local directory (which must contain a ``setup.py``, or pip will report +2. Local directory (which must contain a ``pyproject.toml`` or ``setup.py``, otherwise pip will report an error). 3. Local file (a sdist or wheel format archive, following the naming conventions for those formats). From 28250baffbf1d9dae29644717616a224f511fc87 Mon Sep 17 00:00:00 2001 From: Qiming Xu <33349132+xqm32@users.noreply.github.com> Date: Tue, 28 Nov 2023 14:17:51 +0800 Subject: [PATCH 2/4] Fix line wrap length and add news entry --- docs/html/cli/pip_install.rst | 4 ++-- news/12417.doc.rst | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 news/12417.doc.rst diff --git a/docs/html/cli/pip_install.rst b/docs/html/cli/pip_install.rst index 5569a49c92a..35b82c05e09 100644 --- a/docs/html/cli/pip_install.rst +++ b/docs/html/cli/pip_install.rst @@ -45,8 +45,8 @@ When looking at the items to be installed, pip checks what type of item each is, in the following order: 1. Project or archive URL. -2. Local directory (which must contain a ``pyproject.toml`` or ``setup.py``, otherwise pip will report - an error). +2. Local directory (which must contain a ``pyproject.toml`` or ``setup.py``, + otherwise pip will report an error). 3. Local file (a sdist or wheel format archive, following the naming conventions for those formats). 4. A requirement, as specified in :pep:`440`. diff --git a/news/12417.doc.rst b/news/12417.doc.rst new file mode 100644 index 00000000000..6c1d5c6ee76 --- /dev/null +++ b/news/12417.doc.rst @@ -0,0 +1 @@ +Fix outdated pip install argument description \ No newline at end of file From fe10d368f64501cba0c00ad2adb40b846cd02c61 Mon Sep 17 00:00:00 2001 From: Qiming Xu <33349132+xqm32@users.noreply.github.com> Date: Tue, 28 Nov 2023 14:25:56 +0800 Subject: [PATCH 3/4] Add end line --- news/12417.doc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/news/12417.doc.rst b/news/12417.doc.rst index 6c1d5c6ee76..43b487d26e3 100644 --- a/news/12417.doc.rst +++ b/news/12417.doc.rst @@ -1 +1 @@ -Fix outdated pip install argument description \ No newline at end of file +Fix outdated pip install argument description From d8ab6dc6c1f698d78135f12ebd960f55030679e5 Mon Sep 17 00:00:00 2001 From: Tzu-ping Chung Date: Tue, 28 Nov 2023 15:03:26 +0800 Subject: [PATCH 4/4] Clarify news fragment --- news/12417.doc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/news/12417.doc.rst b/news/12417.doc.rst index 43b487d26e3..efde79a5808 100644 --- a/news/12417.doc.rst +++ b/news/12417.doc.rst @@ -1 +1 @@ -Fix outdated pip install argument description +Fix outdated pip install argument description in documentation.