Skip to content

Commit f1d3500

Browse files
committed
Auto merge of #14562 - epage:revert, r=weihanglo
Revert "remove reference to incomplete crates.io feature from docs" This reverts commit 1735917. As discussed in #13660, my stance on removing the docs was if there wasn't a path forward. There is work progressing on the docs.rs side which will unblock the crates.io side. If the concern for removing the docs is for new crates, then no harm in removing it for now but also little benefit. If its to get existing crates to change, I don't think that ecosystem churn is worth it to try to get everyone to add the link and then remove it again.
2 parents c652c56 + 78cda34 commit f1d3500

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/doc/src/reference/manifest.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,14 +209,18 @@ description = "A short description of my package"
209209
### The `documentation` field
210210

211211
The `documentation` field specifies a URL to a website hosting the crate's
212-
documentation.
212+
documentation. If no URL is specified in the manifest file, [crates.io] will
213+
automatically link your crate to the corresponding [docs.rs] page when the
214+
documentation has been built and is available (see [docs.rs queue]).
213215

214216
```toml
215217
[package]
216218
# ...
217219
documentation = "https://docs.rs/bitflags"
218220
```
219221

222+
[docs.rs queue]: https://docs.rs/releases/queue
223+
220224
### The `readme` field
221225

222226
The `readme` field should be the path to a file in the package root (relative

0 commit comments

Comments
 (0)