Swap sections to original order (#28)

radeklat · Nov 7, 2023 · 8e67c91 · 8e67c91
1 parent f782dec
commit 8e67c91
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,14 @@ Types of changes are:
 
 ## [Unreleased]
 
+## [3.1.2] - 2023-11-07
+
+### Fixes
+
+#### Markdown template
+
+- Swap `possible_values` and `examples` sections, so that `examples` are displayed before `possible_values`. This is the original display order from `2.x`.
+
 ## [3.1.1] - 2023-11-07
 
 ### Fixes
@@ -175,7 +183,8 @@ Add classifiers to the package.
 
 - Initial release
 
-[Unreleased]: https://github.com/radeklat/settings-doc/compare/3.1.1...HEAD
+[Unreleased]: https://github.com/radeklat/settings-doc/compare/3.1.2...HEAD
+[3.1.2]: https://github.com/radeklat/settings-doc/compare/3.1.1...3.1.2
 [3.1.1]: https://github.com/radeklat/settings-doc/compare/3.1.0...3.1.1
 [3.1.0]: https://github.com/radeklat/settings-doc/compare/3.0.1...3.1.0
 [3.0.1]: https://github.com/radeklat/settings-doc/compare/3.0.0...3.0.1

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "settings-doc"
-version = "3.1.1"
+version = "3.1.2"
 description = "A command line tool for generating Markdown documentation and .env files from pydantic BaseSettings."
 authors = ["Radek Lát <[email protected]>"]
 license = "MIT License"

diff --git a/src/settings_doc/templates/markdown.jinja b/src/settings_doc/templates/markdown.jinja
@@ -20,38 +20,6 @@
 
 {{ field.description }}
 {% endif %}
-    {# Possible values #}
-    {% if field.json_schema_extra and "possible_values" in field.json_schema_extra %}
-        {% set possible_values = field.json_schema_extra.possible_values %}
-    {% elif is_typing_literal(field) %}
-        {% set possible_values = field.annotation.__args__ %}
-    {% endif %}
-    {% if possible_values %}
-
-{{ heading(2) }} Possible values
-
-        {% if not is_values_with_descriptions(possible_values) %}
-            {% if possible_values|join("`, `")|length + 2 <= 75 %}
-`{{ possible_values|join("`, `") }}`
-            {% else %}
-                {% for value in possible_values %}
-- `{{ value }}`
-                {% endfor %}
-            {% endif %}
-        {% else %}
-            {% for value in possible_values %}
-                {% if value.__class__.__name__ == "tuple" and value|length <= 2 %}
-                    {% if value|length == 2 %}
-- `{{ value[0] }}`: {{ value[1] }}
-                    {% else %}
-- `{{ value[0] }}`
-                    {% endif %}
-                {% else %}
-- `{{ value }}`
-                {% endif %}
-            {% endfor %}
-        {% endif %}
-    {% endif %}
     {# Example values #}
     {% if field.json_schema_extra and "examples" in field.json_schema_extra %}
     {# `field.json_schema_extra.examples` has no pre-defined structure, so it is more flexible #}
@@ -95,4 +63,36 @@
             {% endfor %}
         {% endif %}
     {% endif %}
+    {# Possible values #}
+    {% if field.json_schema_extra and "possible_values" in field.json_schema_extra %}
+        {% set possible_values = field.json_schema_extra.possible_values %}
+    {% elif is_typing_literal(field) %}
+        {% set possible_values = field.annotation.__args__ %}
+    {% endif %}
+    {% if possible_values %}
+
+{{ heading(2) }} Possible values
+
+        {% if not is_values_with_descriptions(possible_values) %}
+            {% if possible_values|join("`, `")|length + 2 <= 75 %}
+`{{ possible_values|join("`, `") }}`
+            {% else %}
+                {% for value in possible_values %}
+- `{{ value }}`
+                {% endfor %}
+            {% endif %}
+        {% else %}
+            {% for value in possible_values %}
+                {% if value.__class__.__name__ == "tuple" and value|length <= 2 %}
+                    {% if value|length == 2 %}
+- `{{ value[0] }}`: {{ value[1] }}
+                    {% else %}
+- `{{ value[0] }}`
+                    {% endif %}
+                {% else %}
+- `{{ value }}`
+                {% endif %}
+            {% endfor %}
+        {% endif %}
+    {% endif %}
 {% endfor %}
diff --git a/tests/unit/test_markdown.py b/tests/unit/test_markdown.py
@@ -123,10 +123,10 @@ def should_generate_possible_values_and_examples(runner: CliRunner, mocker: Mock
         expected_string = (
             "# `possible_values_and_examples`\n\n"
             "**required**\n\n"
-            "## possible values\n\n"
-            "- `debug`: debug level\n- `info`: info level\n\n"
             "## examples\n\n"
             "- `debug`: debug level\n- `info`: info level\n\n"
+            "## possible values\n\n"
+            "- `debug`: debug level\n- `info`: info level\n\n"
         )
         assert expected_string in run_app_with_settings(mocker, runner, ExamplesSettings)