Fix documentation for package.readme option.
authorEvgen Druzhynin <evgen.druzhynin@gmail.com>
Thu, 19 Oct 2017 10:36:52 +0000 (13:36 +0300)
committerEvgen Druzhynin <evgen.druzhynin@gmail.com>
Thu, 19 Oct 2017 10:36:52 +0000 (13:36 +0300)
src/doc/book/src/reference/manifest.md
src/doc/manifest.md

index 6a79c7a1bac438f38c3285f759a4d065f5f7821f..b10eecaafaa4f6d503cc8e1c3ead982fff7b0dec 100644 (file)
@@ -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
index 6dbed298ce0bbd552bfd85e95c1556b4df7004b6..a8b4a306c7cb9af2379286cd86120d5b76d64d0b 100644 (file)
@@ -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