about summary refs log tree commit diff
path: root/src/doc/style
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2015-04-25 09:55:06 +0000
committerbors <bors@rust-lang.org>2015-04-25 09:55:06 +0000
commite3d00a49803fa75580b912463666d86ce2ee3bb8 (patch)
treeb3f794635fbbf2ab87518d87922cda4612ae2aae /src/doc/style
parent54d65092a49eba959b5cd7a1c4b2e43b3fedba1f (diff)
parent07cc7d9960a1bc767dc051b9fae0c7ad2b5cd97f (diff)
downloadrust-e3d00a49803fa75580b912463666d86ce2ee3bb8.tar.gz
rust-e3d00a49803fa75580b912463666d86ce2ee3bb8.zip
Auto merge of #24783 - jooert:unittestguidelines, r=alexcrichton
Changes the style guidelines regarding unit tests to recommend using a sub-module named "tests" instead of "test" for unit tests as "test" might clash with imports of libtest (see #23870, #24030 and http://users.rust-lang.org/t/guidelines-naming-of-unit-test-module/1078 for previous discussions).

r? @alexcrichton 
Diffstat (limited to 'src/doc/style')
-rw-r--r--src/doc/style/testing/unit.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/doc/style/testing/unit.md b/src/doc/style/testing/unit.md
index 813660d8fdf..dbbe9fc3ac6 100644
--- a/src/doc/style/testing/unit.md
+++ b/src/doc/style/testing/unit.md
@@ -1,10 +1,10 @@
 % Unit testing
 
-Unit tests should live in a `test` submodule at the bottom of the module they
-test. Mark the `test` submodule with `#[cfg(test)]` so it is only compiled when
+Unit tests should live in a `tests` submodule at the bottom of the module they
+test. Mark the `tests` submodule with `#[cfg(test)]` so it is only compiled when
 testing.
 
-The `test` module should contain:
+The `tests` module should contain:
 
 * Imports needed only for testing.
 * Functions marked with `#[test]` striving for full coverage of the parent module's
@@ -17,7 +17,7 @@ For example:
 // Excerpt from std::str
 
 #[cfg(test)]
-mod test {
+mod tests {
     #[test]
     fn test_eq() {
         assert!((eq(&"".to_owned(), &"".to_owned())));