Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Pierre-Sassoulas opened this issue Jan 3, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@Pierre-Sassoulas
Copy link
Collaborator

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
@Pierre-Sassoulas Pierre-Sassoulas added the enhancement New feature or request label Jan 3, 2022
@DanielNoord
Copy link
Owner

DanielNoord commented Jan 3, 2022

👍

As I said in this #8 (comment) I do think this should be optional though as there is no basis in any of the PEP's and I think those should be the guidelines for the tool's standard behaviour.

Something like --quote-argument-names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants