Skip to content

Add check for variable name or non word that should be inside quote #11

Open
@Pierre-Sassoulas

Description

@Pierre-Sassoulas

Syntax checkers do not like variable name inside sentences. Humans can manage, but it's still harder to read. So string like this:
should be inside quote:

def func(named_parameter: str, other, word) -> None:
    """named_parameter should have a nice name

    Other information here, if there's no underscore in it it's a normal word.
    """
    print(named_parameter)
-    """named_parameter should have a nice name
+    """'named_parameter' should have a nice name

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions