Skip to content

Commit

Permalink
docs: update docstring of Container class
Browse files Browse the repository at this point in the history
  • Loading branch information
bradenmacdonald committed Mar 3, 2025
1 parent a9e14e2 commit da571e6
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions openedx_learning/apps/authoring/containers/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,15 @@ class EntityListRow(models.Model):

class Container(PublishableEntityMixin):
"""
A Container is a type of PublishableEntity that holds other
PublishableEntities. For example, a "Unit" Container might hold several
Components.
For now, all containers have a static "entity list" that defines which
containers/components/enities they hold. As we complete the Containers API,
we will also add support for dynamic containers which may contain different
entities for different learners or at different times.
NOTE: We're going to want to eventually have some association between the
PublishLog and Containers that were affected in a publish because their
child elements were published.
Expand Down

0 comments on commit da571e6

Please sign in to comment.