diff options
| author | Stéphane Bidoul <stephane.bidoul@gmail.com> | 2023-03-22 10:14:41 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-22 10:14:41 +0100 |
| commit | 8271fdb349bb519c1b8fe1e02550fd41f5208b70 (patch) | |
| tree | f12c0aefcbf9dfb3fae9362b256a1a46fbbbf5dc /docs | |
| parent | 711b5ac6fda451e6ee3426d13c1f67ee065c311b (diff) | |
| parent | 88b1ce5eec419545eda4f1bfea2c59682f575c17 (diff) | |
| download | pip-8271fdb349bb519c1b8fe1e02550fd41f5208b70.tar.gz | |
Merge pull request #11763 from sbidoul/direct-url-hashes-part-2-sbi
Refine direct URL spec links in install report and inspect docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/html/reference/inspect-report.md | 11 | ||||
| -rw-r--r-- | docs/html/reference/installation-report.md | 9 |
2 files changed, 11 insertions, 9 deletions
diff --git a/docs/html/reference/inspect-report.md b/docs/html/reference/inspect-report.md index 8f4811730..1355e5d42 100644 --- a/docs/html/reference/inspect-report.md +++ b/docs/html/reference/inspect-report.md @@ -23,7 +23,7 @@ The report is a JSON object with the following properties: - `pip_version`: a string with the version of pip used to produce the report. -- `installed`: an array of [InspectReportItem](InspectReportItem) representing the +- `installed`: an array of [`InspectReportItem`](InspectReportItem) representing the distribution packages that are installed. - `environment`: an object describing the environment where the installation report was @@ -50,10 +50,11 @@ the following properties: ``` - `direct_url`: Information about the direct URL that was used for installation, if any, - using the [direct - URL](https://packaging.python.org/en/latest/specifications/direct-url/) data - structure. In most case, this field corresponds to the `direct_url.json` metadata, - except for legacy editable installs, where it is emulated. + using the [direct URL data + structure](https://packaging.python.org/en/latest/specifications/direct-url-data-structure/). + In most case, this field corresponds to the + [`direct_url.json`](https://packaging.python.org/en/latest/specifications/direct-url) + metadata, except for legacy editable installs, where it is emulated. - `requested`: `true` if the `REQUESTED` metadata is present, `false` otherwise. This field is only present for modern `.dist-info` installations. diff --git a/docs/html/reference/installation-report.md b/docs/html/reference/installation-report.md index 6ed5f659c..cc2e23b2a 100644 --- a/docs/html/reference/installation-report.md +++ b/docs/html/reference/installation-report.md @@ -36,7 +36,7 @@ The report is a JSON object with the following properties: - `pip_version`: a string with the version of pip used to produce the report. -- `install`: an array of [InstallationReportItem](InstallationReportItem) representing +- `install`: an array of [`InstallationReportItem`](InstallationReportItem) representing the distribution packages (to be) installed. - `environment`: an object describing the environment where the installation report was @@ -58,9 +58,10 @@ package with the following properties: specifier. - `download_info`: Information about the artifact (to be) downloaded for installation, - using the [direct - URL](https://packaging.python.org/en/latest/specifications/direct-url/) data - structure. When `is_direct` is `true`, this field is the same as the `direct_url.json` + using the [direct URL data + structure](https://packaging.python.org/en/latest/specifications/direct-url-data-structure/). + When `is_direct` is `true`, this field is the same as the + [`direct_url.json`](https://packaging.python.org/en/latest/specifications/direct-url) metadata, otherwise it represents the URL of the artifact obtained from the index or `--find-links`. |