about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2015-10-17 15:10:07 +0000
committerbors <bors@rust-lang.org>2015-10-17 15:10:07 +0000
commit971856d0ecc8a37fa06bad2738a992c0e6c459a0 (patch)
tree85a0ed31dc21c323ce75dcf74e5c0de246fca5e2
parentc7a58b534e61f65e9f3724ec921ec7a3396efdcc (diff)
parentcf926f1c18404a49b4f407f961e009e43b4e8fb4 (diff)
downloadrust-971856d0ecc8a37fa06bad2738a992c0e6c459a0.tar.gz
rust-971856d0ecc8a37fa06bad2738a992c0e6c459a0.zip
Auto merge of #29089 - kickinbahk:edit-testing-docs, r=steveklabnik
When going through the docs, it is not clear that binary files cannot be tested. Additionally, it is hard to find the proper structure of a Rust crate and it took me several hours of looking through the docs to find the crates and modules section. I think we can link to it from here and it will be beneficial to those who are coming to the language.
-rw-r--r--src/doc/trpl/testing.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/doc/trpl/testing.md b/src/doc/trpl/testing.md
index b278ea01276..c6aeb86f7d3 100644
--- a/src/doc/trpl/testing.md
+++ b/src/doc/trpl/testing.md
@@ -504,3 +504,6 @@ you add more examples.
 
 We haven’t covered all of the details with writing documentation tests. For more,
 please see the [Documentation chapter](documentation.html)
+
+One final note: Tests *cannot* be run on a binary file. To see more on file arrangement see the [Crates and Modules](crates-and-modules.html) section.
+