make sure function names are readable

Docs > Code Analysis > Static Analysis Rules > make sure function names are readable

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

ID: python-best-practices/ambiguous-function-name

Language: Python

Severity: Notice

Category: Best Practices

Description

In some fonts, these characters are indistinguishable from the numerals one and zero. Use characters that are not ambiguous.

Non-Compliant Code Examples

def I():  # use i instead
    pass

Compliant Code Examples

def i():
    pass

How to use this rule

1
2
rulesets:
  - python-best-practices     # Rules to enforce Python best practices.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products