Skip to content

Commit 0461165

Browse files
committed
Auto merge of #14561 - RalfJung:crates-io-docs, r=weihanglo
remove reference to incomplete crates.io feature from docs The cargo docs for the `documentation` field currently are written in a way that makes it sound like if I want to use docs.rs, I can just leave the field empty. However, that is not the case: leaving the field empty will never show a "Documentation" link in the search results, so there's always an unnecessary extra click to go from "type crate name into search" to reaching the docs. This crates.io limitation is tracked at rust-lang/crates.io#1484. It doesn't really matter whether this is a bug or a missing feature, the point is that cargo docs are misrepresenting what crates.io does in a way that leads to a suboptimal user experience (many crates without "Documentation" link in crates.io search results). Since the suggestion to document what crates.io actually does was rejected (#13660), I suggest we instead stop mentioning this feature at all -- that's still clearly better than mentioning it while it is not yet fully implemented / while it has some significant *undocumented* limitation.
2 parents 7f44292 + 1735917 commit 0461165

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

Diff for: src/doc/src/reference/manifest.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -209,18 +209,14 @@ 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. 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]).
212+
documentation.
215213

216214
```toml
217215
[package]
218216
# ...
219217
documentation = "https://docs.rs/bitflags"
220218
```
221219

222-
[docs.rs queue]: https://docs.rs/releases/queue
223-
224220
### The `readme` field
225221

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

0 commit comments

Comments
 (0)