Skip to content

Commit bd30f01

Browse files
committed
docs: Clarify that crates.io doesn't link to docs.rs right away.
1 parent 6b872ab commit bd30f01

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/doc/src/reference/manifest.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,14 +203,17 @@ description = "A short description of my package"
203203

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

208209
```toml
209210
[package]
210211
# ...
211212
documentation = "https://docs.rs/bitflags"
212213
```
213214

215+
[docs.rs queue]: https://docs.rs/releases/queue
216+
214217
#### The `readme` field
215218

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

0 commit comments

Comments
 (0)