add possible values

maykinmedia · Jan 9, 2025 · c7b8536 · c7b8536
1 parent d7a327e
commit c7b8536
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/django_setup_configuration/documentation/model_directive.py b/django_setup_configuration/documentation/model_directive.py
@@ -3,7 +3,7 @@
 import textwrap
 from dataclasses import dataclass
 from enum import Enum
-from typing import Annotated, Any, Dict, Type, Union, get_args, get_origin
+from typing import Annotated, Any, Dict, Type, Union, get_args, get_origin, Literal
 
 import ruamel.yaml
 from docutils import nodes
@@ -75,10 +75,17 @@ def insert_example_with_comments(
         yaml_set_comment_with_max_length(
             example_data, field_name, field_info.description, 80, indent=depth * 2
         )
+
     if default := get_default_from_field_info(field_info):
         example_data.yaml_set_comment_before_after_key(
             field_name, f"default value: {default}", indent=depth * 2
         )
+
+    if get_origin(field_info.annotation) == Literal:
+        example_data.yaml_set_comment_before_after_key(
+            field_name, f"possible values: {get_args(field_info.annotation)}", indent=depth * 2
+        )
+
     example_data.yaml_set_comment_before_after_key(
         field_name, f"required: {field_info.is_required()}", indent=depth * 2
     )