refactor: Rename CollectionKey to LibCollectionKey and CollectionLoca…

…tor to LibCollectionLocator
openedx · Aug 27, 2024 · a16a3ee · a16a3ee
1 parent 6e23233
commit a16a3ee
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/opaque_keys/edx/keys.py b/opaque_keys/edx/keys.py
@@ -89,7 +89,7 @@ def make_asset_key(self, asset_type: str, path: str) -> AssetKey:  # pragma: no
         raise NotImplementedError()
 
 
-class CollectionKey(LearningContextKey):
+class LibCollectionKey(LearningContextKey):
     """
     An :class:`opaque_keys.OpaqueKey` identifying a particular Library Collection object.
     """

diff --git a/opaque_keys/edx/locator.py b/opaque_keys/edx/locator.py
@@ -1623,7 +1623,7 @@ def html_id(self) -> str:
         return str(self)
 
 
-class CollectionLocator(CheckFieldMixin, CollectionKey):
+class LibCollectionLocator(CheckFieldMixin, CollectionKey):
     """
     When serialized, these keys look like:
         lib-collection:org:lib:collection-id

diff --git a/setup.py b/setup.py
@@ -131,7 +131,7 @@ def get_version(*file_paths):
             'course-v1 = opaque_keys.edx.locator:CourseLocator',
             'library-v1 = opaque_keys.edx.locator:LibraryLocator',
             'lib = opaque_keys.edx.locator:LibraryLocatorV2',
-            'lib-collection = opaque_keys.edx.locator:CollectionLocator',
+            'lib-collection = opaque_keys.edx.locator:LibCollectionLocator',
             # don't use slashes in any new code
             'slashes = opaque_keys.edx.locator:CourseLocator',
         ],