Auto merge of #4644 - dethoter:4620, r=matklad

Fix documentation for package.readme option. Fix for #4620.
rust-lang · Oct 26, 2017 · b3ba626 · b3ba626
2 parents e3b0cf6 + 5ccf654
commit b3ba626
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/src/doc/book/src/reference/manifest.md b/src/doc/book/src/reference/manifest.md
@@ -155,6 +155,7 @@ repository = "..."
 
 # This points to a file under the package root (relative to this `Cargo.toml`).
 # The contents of this file are stored and indexed in the registry.
+# crates.io will render this file and place the result on the crate's page.
 readme = "..."
 
 # This is a list of up to five keywords that describe this crate. Keywords

diff --git a/src/doc/manifest.md b/src/doc/manifest.md
@@ -152,6 +152,7 @@ repository = "..."
 
 # This points to a file under the package root (relative to this `Cargo.toml`).
 # The contents of this file are stored and indexed in the registry.
+# crates.io will render this file and place the result on the crate's page.
 readme = "..."
 
 # This is a list of up to five keywords that describe this crate. Keywords