Check class names 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: ruby-inclusive/class-definition

Language: Ruby

Severity: Notice

Category: Best Practices

Description

In Ruby, class names should be meaningful and concise, and follow the naming conventions. Avoid using terms that might be considered offensive, derogatory, or otherwise inappropriate. Instead, use terminology that accurately represents the functionality or role of the class.

For instance, instead of using MasterClass, consider using PrimaryClass, MainClass, or another appropriate term that doesn’t have potentially negative connotations.

Non-Compliant Code Examples

class MasterClass
    def my_method
    end
end

Compliant Code Examples

class PrimaryClass
    def my_method
    end
end
https://static.datadoghq.com/static/images/logos/github_avatar.svg https://static.datadoghq.com/static/images/logos/vscode_avatar.svg jetbrains

Seamless integrations. Try Datadog Code Analysis

PREVIEWING: Cyril-Bouchiat/add-vm-package-explorer-doc