Skip to content

Commit b375bea

Browse files
committed
Improve the wording of dl documentation.
1 parent 3c6d458 commit b375bea

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

src/doc/src/reference/registries.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -127,12 +127,17 @@ looks like:
127127

128128
The keys are:
129129
- `dl`: This is the URL for downloading crates listed in the index. The value
130-
may have the markers `{crate}` and `{version}` which are replaced with the
131-
name and version of the crate to download, or the marker `{prefix}` which is
132-
replaced with the crate's prefix, or the marker `{lowerprefix}` which is
133-
replaced with the crate's prefix converted to lowercase. If none of the
134-
markers are present, then the value `/{crate}/{version}/download` is appended
135-
to the end. See below for more about crate prefixes.
130+
may have the following markers which will be replaced with their
131+
corresponding value:
132+
133+
- `{crate}`: The name of crate.
134+
- `{version}`: The crate version.
135+
- `{prefix}`: A directory prefix computed from the crate name. For example,
136+
a crate named `cargo` has a prefix of `ca/rg`. See below for details.
137+
- `{lowerprefix}`: Lowercase variant of `{prefix}`.
138+
139+
If none of the markers are present, then the value
140+
`/{crate}/{version}/download` is appended to the end.
136141
- `api`: This is the base URL for the web API. This key is optional, but if it
137142
is not specified, commands such as [`cargo publish`] will not work. The web
138143
API is described below.

0 commit comments

Comments
 (0)