Preserve JSON key order in YAML, refs #1153

simonw · Jul 8, 2023 · 0183e1a · 0183e1a
1 parent 38fcc96
commit 0183e1a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/metadata.rst b/docs/metadata.rst
@@ -30,12 +30,12 @@ Your ``metadata.yaml`` file can look something like this:
 
     .. code-block:: yaml
 
+        title: Custom title for your index page
         description: Some description text can go here
         license: ODbL
         license_url: https://opendatacommons.org/licenses/odbl/
         source: Original Data Source
         source_url: http://example.com/
-        title: Custom title for your index page
 
 
 .. tab:: JSON

diff --git a/docs/metadata_doc.py b/docs/metadata_doc.py
@@ -6,7 +6,7 @@
 def metadata_example(cog, example):
     cog.out("\n.. tab:: YAML\n\n")
     cog.out("    .. code-block:: yaml\n\n")
-    cog.out(textwrap.indent(yaml.dump(example), "        "))
+    cog.out(textwrap.indent(yaml.safe_dump(example, sort_keys=False), "        "))
     cog.out("\n\n.. tab:: JSON\n\n")
     cog.out("    .. code-block:: json\n\n")
     cog.out(textwrap.indent(json.dumps(example, indent=2), "        "))