Skip to content

Detect code block contents without "base indentation" in docs #15024

Open
@ojeda

Description

@ojeda

What it does

In many projects, it is likely that no indentation is not indented.

Such a lint would find a few hits, e.g. there are currently a few in stdarch.

Having said that, when/if rustfmt stabilizes formatting code blocks in documentation, this lint may not be needed anymore.

Possibly related, at least implementation-wise: #15023 and #15025.

Advantage

  • More consistency in docs.
  • Less time spent by reviewers.

Drawbacks

No response

Example

/// ```
///fn f() {}
/// ```

Should be written as:

/// ```
/// fn f() {}
/// ```

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-lintArea: New lints

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions