From 1468b190ac4f9ec05b88b4efcbb8802d67b401f8 Mon Sep 17 00:00:00 2001 From: kickinbahk Date: Thu, 15 Oct 2015 17:44:21 -0700 Subject: [PATCH 1/2] Add to Testing docs to make more clear 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. --- src/doc/trpl/testing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/doc/trpl/testing.md b/src/doc/trpl/testing.md index b278ea0127686..2f35290b4b1ad 100644 --- a/src/doc/trpl/testing.md +++ b/src/doc/trpl/testing.md @@ -504,3 +504,5 @@ 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 the binary (main) file. To see more on file arrangement see the [Crates and Modules](https://doc.rust-lang.org/stable/book/crates-and-modules.html) Section From cf926f1c18404a49b4f407f961e009e43b4e8fb4 Mon Sep 17 00:00:00 2001 From: kickinbahk Date: Fri, 16 Oct 2015 11:45:22 -0700 Subject: [PATCH 2/2] Update the testing doc to be more clear and include dynamic link Fixed some typos and changed the link to the link to crates-and-modules to be dynamic. --- src/doc/trpl/testing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/doc/trpl/testing.md b/src/doc/trpl/testing.md index 2f35290b4b1ad..c6aeb86f7d32a 100644 --- a/src/doc/trpl/testing.md +++ b/src/doc/trpl/testing.md @@ -505,4 +505,5 @@ 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 the binary (main) file. To see more on file arrangement see the [Crates and Modules](https://doc.rust-lang.org/stable/book/crates-and-modules.html) Section +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. +