Skip to content

Warn on missing "Errors" section in docs for Result/Option returning methods. #4854

Closed
@Lokathor

Description

@Lokathor

Recently clippy added a warning for missing "Safety" sections in public unsafe methods/functions.

I'd like to see a similar thing for methods/functions that return Option or Result but don't have a "Errors" section in their doc.

(allow by default of course, we don't want to give people a heart attack)

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-lintArea: New lintsL-styleLint: Belongs in the style lint groupgood first issueThese issues are a good way to get started with Clippy

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions