Skip to content

Warn methods in doc comments written as fun() instead of fun #1750

Open
@clarfonthey

Description

@clarfonthey

According to #41771 (comment), the current convention for rustdoc is to write methods without any trailing parentheses. For example, the comment "Resizes the Vec in-place so that len() is equal to new_len" should really be "Resizes the Vec in-place so that len is equal to new_len".

Would be nice if we had some way for clippy to warn about this convention.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-documentationArea: Adding or improving documentationL-styleLint: Belongs in the style lint groupS-needs-discussionStatus: Needs further discussion before merging or work can be startedT-ASTType: Requires working with the AST

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions