about summary refs log tree commit diff
path: root/compiler/rustc_driver/src
diff options
context:
space:
mode:
authorYuki Okushi <jtitor@2k36.org>2021-09-17 14:09:46 +0900
committerGitHub <noreply@github.com>2021-09-17 14:09:46 +0900
commit758c7bcc58387178ee0d7c454e6cf748a44a8618 (patch)
tree076453a5b424ca955982670f42764d6731fa6e9d /compiler/rustc_driver/src
parent0f06e366035fef3034c82c5ae80f7ecabd8bafbd (diff)
parent5f464bb7f2d3656837a6fa4f6d2265a86e02e5b4 (diff)
downloadrust-758c7bcc58387178ee0d7c454e6cf748a44a8618.tar.gz
rust-758c7bcc58387178ee0d7c454e6cf748a44a8618.zip
Rollup merge of #88735 - hnj2:patch-1, r=GuillaumeGomez
Don't lint about missing code examples in derived traits

When the `missing_doc_code_examples` lint is performed it also requires that derived Trait implementations have a code example for each member etc., which causes undesirable behavior.

# Examples

With `missing_doc_code_examples` enable we are not able to use the `Clone` derive macro due to the generated code not being documented:
```rust
#[deny(rustdoc::missing_doc_code_examples)]

/// docs
/// ```
/// let s = SomeStruct;
/// ```
#[derive(Clone)]
pub struct SomeStruct;
```
yields:
```
 Documenting testt v0.1.0 (<redacted>)
error: missing code example in this documentation
 --> src/lib.rs:7:10
  |
7 | #[derive(Clone)]
  |          ^^^^^
  |
note: the lint level is defined here
 --> src/lib.rs:1:8
  |
1 | #[deny(rustdoc::missing_doc_code_examples)]
  |        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing code example in this documentation
 --> src/lib.rs:7:10
  |
7 | #[derive(Clone)]
  |          ^^^^^

error: could not document `testt`

Caused by:
  process didn't exit successfully: `rustdoc ...
```

closes #81775
Diffstat (limited to 'compiler/rustc_driver/src')
0 files changed, 0 insertions, 0 deletions