missing-docs

Require documentation for named declarations

Undocumented declarations hide their purpose and constraints from readers and generated references.
Instead, you SHOULD document every type, function, constant, nominal member, variant, and direct
member of a named object type.

Exact interface implementations inherit the documentation of their requirement.
Anonymous structural types and index signatures inherit the documentation of their enclosing
declaration.

- Category: style
- Level: warning
- Fix: none
- Scope: module

Reported

struct Session {
    /// The authenticated user.
    userId: string;
}
Accepted

/// One authenticated user session.
struct Session {
    /// The authenticated user.
    userId: string;
}
Prior art

- rustc · missingdocs

language/linter/src/rules/style/missingdocs.rs:9