mirror of
https://github.com/rust-lang/rust.git
synced 2025-01-03 03:16:23 +00:00
Rollup merge of #33253 - ergenekonyigit:master, r=alexcrichton
rustdoc: fixed some RFCs r? @alexcrichton
This commit is contained in:
commit
3a0efffc9d
@ -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.
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
## `return` [FIXME: needs RFC]
|
||||
## `return` [RFC #968]
|
||||
|
||||
Terminate `return` statements with semicolons:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user