style: Add comments

openedx_learning/apps/authoring/collections/api.py

@@ -211,6 +211,10 @@ def remove_unpublished_from_collections(learning_package_id: int) -> None:
     """
     Removes all unpublished entities from collections for a
     given learning package.
+
+    One use case for this function is when reverting to published.
+    If a collection has unpublished entities and the learning package is reverted
+    to the published version, the unpublished entities need to be removed.
     """
     collections = get_collections(learning_package_id)