RS.CLIPPY.EMPTY_DOCS

Docstrings exist but documentation is empty

This checker is a Clippy lint created by The Rust Project Contributors. The documentation shown here is a copy of the original documentation for: empty_docs. Copyright ©2025 The Rust Team. All rights reserved.

What it does

Detects documentation that is empty.

Why is this bad?

Empty docs clutter code without adding value, reducing readability and maintainability.

Example

///
fn returns_true() -> bool {
    true
}

Use instead:

fn returns_true() -> bool {
    true
}