about summary refs log tree commit diff
diff options
context:
space:
mode:
authorManish Goregaokar <manishsmail@gmail.com>2016-04-29 16:03:31 +0530
committerManish Goregaokar <manishsmail@gmail.com>2016-04-29 19:17:58 +0530
commit3a0efffc9dd2df5b55ee0e111875a018aaa4ecf9 (patch)
tree2e143e4ea36a9f2d54bab69916f0e368a7dee6ed
parent13c1956f7c548fe7f81060e00233be2cb1a86a70 (diff)
parent0e698ed2c6b53a09dd03cafaa28e54f1cbd7f75b (diff)
downloadrust-3a0efffc9dd2df5b55ee0e111875a018aaa4ecf9.tar.gz
rust-3a0efffc9dd2df5b55ee0e111875a018aaa4ecf9.zip
Rollup merge of #33253 - ergenekonyigit:master, r=alexcrichton
rustdoc: fixed some RFCs

r? @alexcrichton
-rw-r--r--src/doc/style/style/comments.md22
-rw-r--r--src/doc/style/style/features.md2
2 files changed, 21 insertions, 3 deletions
diff --git a/src/doc/style/style/comments.md b/src/doc/style/style/comments.md
index bf8cf653dbb..af02d87cc8d 100644
--- a/src/doc/style/style/comments.md
+++ b/src/doc/style/style/comments.md
@@ -1,4 +1,4 @@
-% Comments [FIXME: needs RFC]
+% Comments [RFC #505]
 
 ### Avoid block comments.
 
@@ -74,7 +74,25 @@ For example:
 
 ### Code snippets
 
-> **[FIXME]**
+Only use inner doc comments `//!` to write crate and module-level documentation,
+nothing else. When using `mod` blocks, prefer `///` outside of the block:
+
+```rust
+/// This module contains tests
+mod test {
+    // ...
+}
+```
+
+over
+
+```rust
+mod test {
+    //! This module contains tests
+
+    // ...
+}
+```
 
 ### Avoid inner doc comments.
 
diff --git a/src/doc/style/style/features.md b/src/doc/style/style/features.md
index 578270fbdc2..13cc37fc236 100644
--- a/src/doc/style/style/features.md
+++ b/src/doc/style/style/features.md
@@ -1,4 +1,4 @@
-## `return` [FIXME: needs RFC]
+## `return` [RFC #968]
 
 Terminate `return` statements with semicolons: