docs: minor clarifications

openedx · Oct 20, 2023 · aff40fd · aff40fd
1 parent ee6d554
commit aff40fd
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/tests/openedx_tagging/core/tagging/test_views.py b/tests/openedx_tagging/core/tagging/test_views.py
@@ -1189,10 +1189,10 @@ def test_large_search(self):
         data = response.data
         results = data["results"]
         assert pretty_format_tags(results, usage_count=None) == [
-            "Tag 0 (None) (children: 12)",  # First 3 results don't match but have children that match
+            "Tag 0 (None) (children: 12)",  # First 2 results don't match but have children that match
             "  Tag 1 (Tag 0) (children: 12)",
             "    Tag 11 (Tag 1) (children: 0)",
-            "  Tag 105 (Tag 0) (children: 12)",
+            "  Tag 105 (Tag 0) (children: 12)",  # Non-match but children match
             "    Tag 110 (Tag 105) (children: 0)",
             "    Tag 111 (Tag 105) (children: 0)",
             "    Tag 112 (Tag 105) (children: 0)",

diff --git a/tests/openedx_tagging/core/tagging/utils.py b/tests/openedx_tagging/core/tagging/utils.py
@@ -9,6 +9,7 @@ def pretty_format_tags(result, parent=True, external_id=False, usage_count=True)
     Format the result of get_filtered_tags() to be more human readable.
 
     Also works with other wrappers around get_filtered_tags, like api.get_tags()
+    Also works with serialized TagData from the REST API.
     """
     pretty_results = []
     for t in result: