dtolnay / dtolnay/prettyplease
Use `///` for all docs
- Dominant language
- Rust
- Stars
- 772
- Forks
- 48
- PR merge metrics
- No merged PRs in 30d
Description
Hi! Is there any reason why multi-line docs are formatted using `/**`?
For example, the following code:
```rust
#[doc = " This is a single line doc"]
pub type foo = ::std::os::raw::c_int;
#[doc = " This is a multi line doc.\n With way too many lines"]
pub type bar = ::std::os::raw::c_int;
```
is being formatted as
```rust
/// This is a single line doc
pub type foo = ::std::os::raw::c_int;
/** This is a multi line doc.
With way too many lines*/
pub type bar = ::std::os::raw::c_int;
```
and I'd like it to be
```rust
/// This is a single line doc
pub type foo = ::std::os::raw::c_int;
/// This is a multi line doc.
/// With way too many lines
pub type bar = ::std::os::raw::c_int;
```
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.