docs: add configuration examples for known-enum-bases option

Author: imtoopunkforyou

CHANGELOG.md

@@ -17,6 +17,14 @@ Semantic versioning in our case means:
   change the client facing API, change code conventions significantly, etc.
 
 
+## WIP
+
+### Misc
+
+- Minor refactoring `wemake_python_styleguide.logic.naming.enums.has_enum_like_base_with_config`, #3518
+- Improves `--known-enum-bases` option help text and documentation, #3518
+
+
 ## 1.4.0
 
 ### Features

wemake_python_styleguide/logic/naming/enums.py

@@ -86,9 +86,13 @@ def has_enum_like_base_with_config(
 
     enum_bases = config.known_enum_bases
     if enum_bases:
-        normalized: tuple[str, ...] = tuple({
-            name for base in enum_bases for name in (base, base.split('.')[-1])
-        })
-        return _has_one_of_base_classes(defn, normalized)
+        return _has_one_of_base_classes(
+            defn,
+            tuple({
+                name
+                for base in enum_bases
+                for name in (base, base.split('.')[-1])
+            }),
+        )
 
     return False

wemake_python_styleguide/options/config.py

@@ -289,8 +289,7 @@ class Configuration:
         _Option(
             '--known-enum-bases',
             defaults.KNOWN_ENUM_BASES,
-            'List of additional enum-like base class names that should be '
-            'treated as enums.',
+            'List of additional enum-like base class names.',
             type=String,
             comma_separated_list=True,
         ),

wemake_python_styleguide/violations/naming.py

@@ -453,6 +453,20 @@ class UpperCaseAttributeViolation(ASTViolation):
         Default:
         :str:`wemake_python_styleguide.options.defaults.KNOWN_ENUM_BASES`
 
+        You can configure custom enum-like base classes that should be treated
+        as enums:
+
+        .. code:: ini
+
+            [flake8]
+            known-enum-bases = BaseEnum, constants.AnotherBaseEnum
+
+        Or via command line:
+
+        .. code:: bash
+
+            flake8 --known-enum-bases=BaseEnum,constants.AnotherBaseEnum ./
+
     Example::
 
         # Correct:
@@ -465,6 +479,14 @@ class Color(enum.Enum):
             WHITE = 0
             LIGHT_GRAY = 1
 
+        # Correct with `--known-enum-bases=BaseEnum` option:
+        class BaseEnum(enum.Enum):
+            pass
+
+        class MyEnum(BaseEnum):
+            HELLO = 'hello'
+            WORLD = 'world'
+
         # Wrong:
         class A:
             MY_CONSTANT = 42