Skip to content

Commit 4e5b333

Browse files
bradenmacdonaldChrisChV
authored andcommitted
docs: add a little note about avoiding 'vertical' where possible
1 parent 3275b47 commit 4e5b333

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/generic/key-utils.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,14 @@ export const buildCollectionUsageKey = (learningContextKey: string, collectionId
5252

5353
export enum ContainerType {
5454
Unit = 'unit',
55+
/**
56+
* Vertical is the old name for Unit. Generally, **please avoid using this term entirely in any libraries code** or
57+
* anything based on the new Learning Core "Containers" framework - just call it a unit. We do still need to use this
58+
* in the modulestore-based courseware, and currently the /xblock/ API used to copy library containers into courses
59+
* also requires specifying this, though that should change to a better API that does the unit->vertical conversion
60+
* automatically in the future.
61+
* TODO: we should probably move this to a separate enum/mapping, and keep this for the new container types only.
62+
*/
5563
Vertical = 'vertical',
5664
}
5765

0 commit comments

Comments
 (0)