Metadata

ID: ruby-inclusive/comments

Language: Ruby

Severity: Notice

Category: Best Practices

Description

This rule checks the comments in your Ruby code for potentially insensitive or inappropriate wording. It specifically flags terms considered problematic due to historical connotations.

To avoid violating this rule, use neutral, descriptive terms in your comments. For example, instead of using “master”, you could use terms like “primary”, “main”, or “leader”.

Non-Compliant Code Examples

# master
print("foo")

Compliant Code Examples

# primary
print("foo")

Seamless integrations. Try Datadog Code Analysis

Datadog Code Analysis