From d1f1ac09e93c3e7fa86833fb6a99f219c9b24906 Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Wed, 27 Mar 2024 10:56:18 +0100 Subject: [PATCH] clarify default documentation behavior --- src/doc/src/reference/manifest.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/doc/src/reference/manifest.md b/src/doc/src/reference/manifest.md index aeecf8b16e8..19219f7a56e 100644 --- a/src/doc/src/reference/manifest.md +++ b/src/doc/src/reference/manifest.md @@ -205,9 +205,12 @@ description = "A short description of my package" ### The `documentation` field The `documentation` field specifies a URL to a website hosting the crate's -documentation. If no URL is specified in the manifest file, [crates.io] will +documentation. + +If no URL is specified in the manifest file, [crates.io] will automatically link your crate to the corresponding [docs.rs] page when the documentation has been built and is available (see [docs.rs queue]). +However, this automatic link appears only on the crate page, not in search results. ```toml [package]