add test for docdict order

template/utils/tests/test_docs.py

@@ -1,8 +1,11 @@
 """Test _docs.py"""
 
+import re
+from pathlib import Path
+
 import pytest
 
-from .._docs import copy_doc, fill_doc
+from .._docs import copy_doc, docdict, fill_doc
 from ..logs import verbose
 
 
@@ -207,3 +210,16 @@ def method4(verbose=None):
     assert foo.method1.__doc__ == foo2.method2.__doc__
     assert foo.method1.__doc__ == foo2.method3.__doc__
     assert foo.method1.__doc__ == foo2.method4.__doc__
+
+
+def test_docdict_order():
+    """Test that docdict is alphabetical."""
+    # read the file as text, and get entries via regex
+    docs_path = Path(__file__).parents[1] / "_docs.py"
+    assert docs_path.is_file()
+    with open(docs_path, "r", encoding="UTF-8") as fid:
+        docs = fid.read()
+    entries = re.findall(r'docdict\[(?:\n    )?["\'](.+)["\']\n?\] = ', docs)
+    # test length, uniqueness and order
+    assert len(docdict) == len(entries)
+    assert sorted(entries) == entries