check comments for wording issues

Docs > Code Analysis > Static Analysis Rules > check comments for wording issues

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Metadata

ID: python-inclusive/comments

Language: Python

Severity: Notice

Category: Code Style

Description

Check the variable names and suggest better names.

Examples of replacement suggestions:

blacklist with denylist
whitelist with allowlist
master with primary
slave with secondary

Non-Compliant Code Examples

# whitelist names to prevent unauthorized usage
def filter_names(names):
    pass

# she SHE should check her code    
def new_function_from_helen():
    pass


class Foo:
    # he should check his
    def new_function_from_joe():
        pass

Compliant Code Examples

# allowlist names to prevent unauthorized usage
def filter_names(names):
    pass

# the comments do not have an history of issues
def foo(bar):
    baz()