Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions src/doc/style/style/comments.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% Comments [FIXME: needs RFC]
% Comments [RFC #505]

### Avoid block comments.

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/doc/style/style/features.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## `return` [FIXME: needs RFC]
## `return` [RFC #968]

Terminate `return` statements with semicolons:

Expand Down