Skip to content

Commit 8271fdb

Browse files
authored
Merge pull request #11763 from sbidoul/direct-url-hashes-part-2-sbi
Refine direct URL spec links in install report and inspect docs
2 parents 711b5ac + 88b1ce5 commit 8271fdb

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

docs/html/reference/inspect-report.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The report is a JSON object with the following properties:
2323

2424
- `pip_version`: a string with the version of pip used to produce the report.
2525

26-
- `installed`: an array of [InspectReportItem](InspectReportItem) representing the
26+
- `installed`: an array of [`InspectReportItem`](InspectReportItem) representing the
2727
distribution packages that are installed.
2828

2929
- `environment`: an object describing the environment where the installation report was
@@ -50,10 +50,11 @@ the following properties:
5050
```
5151

5252
- `direct_url`: Information about the direct URL that was used for installation, if any,
53-
using the [direct
54-
URL](https://packaging.python.org/en/latest/specifications/direct-url/) data
55-
structure. In most case, this field corresponds to the `direct_url.json` metadata,
56-
except for legacy editable installs, where it is emulated.
53+
using the [direct URL data
54+
structure](https://packaging.python.org/en/latest/specifications/direct-url-data-structure/).
55+
In most case, this field corresponds to the
56+
[`direct_url.json`](https://packaging.python.org/en/latest/specifications/direct-url)
57+
metadata, except for legacy editable installs, where it is emulated.
5758

5859
- `requested`: `true` if the `REQUESTED` metadata is present, `false` otherwise. This
5960
field is only present for modern `.dist-info` installations.

docs/html/reference/installation-report.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The report is a JSON object with the following properties:
3636

3737
- `pip_version`: a string with the version of pip used to produce the report.
3838

39-
- `install`: an array of [InstallationReportItem](InstallationReportItem) representing
39+
- `install`: an array of [`InstallationReportItem`](InstallationReportItem) representing
4040
the distribution packages (to be) installed.
4141

4242
- `environment`: an object describing the environment where the installation report was
@@ -58,9 +58,10 @@ package with the following properties:
5858
specifier.
5959

6060
- `download_info`: Information about the artifact (to be) downloaded for installation,
61-
using the [direct
62-
URL](https://packaging.python.org/en/latest/specifications/direct-url/) data
63-
structure. When `is_direct` is `true`, this field is the same as the `direct_url.json`
61+
using the [direct URL data
62+
structure](https://packaging.python.org/en/latest/specifications/direct-url-data-structure/).
63+
When `is_direct` is `true`, this field is the same as the
64+
[`direct_url.json`](https://packaging.python.org/en/latest/specifications/direct-url)
6465
metadata, otherwise it represents the URL of the artifact obtained from the index or
6566
`--find-links`.
6667

0 commit comments

Comments
 (0)