docs: It's all stable

Author: kdmccormick

src/openedx_content/applets/containers/api.py

@@ -74,7 +74,6 @@
 @dataclass(frozen=True)
 class ContainerEntityListEntry:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Data about a single entity in a container, e.g. a component in a unit.
     """
 
@@ -143,7 +142,6 @@ def create_container(
     can_stand_alone: bool = True,
 ) -> ContainerModel:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Create a new container.
 
     Args:
@@ -183,7 +181,6 @@ def create_container(
 
 def create_entity_list() -> EntityList:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Create a new entity list. This is an structure that holds a list of entities
     that will be referenced by the container.
 
@@ -199,7 +196,6 @@ def create_entity_list_with_rows(
     learning_package_id: LearningPackage.ID | None,
 ) -> EntityList:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Create new entity list rows for an entity list.
 
     Args:
@@ -305,7 +301,6 @@ def create_container_version(
     created_by: int | None,
 ) -> ContainerVersion:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Create a new container version.
 
     Args:
@@ -355,7 +350,6 @@ def create_container_and_version(
     can_stand_alone: bool = True,
 ) -> tuple[ContainerModel, ContainerVersionModel]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ] Create a new container and its initial version.
 
     Args:
         learning_package_id: The learning package ID.
@@ -470,7 +464,6 @@ def create_next_container_version(
     force_version_num: int | None = None,
 ) -> ContainerVersion:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Create the next version of a container. A new version of the container is created
     only when its metadata changes:
 
@@ -543,7 +536,6 @@ def create_next_container_version(
 
 def get_container(pk: Container.ID) -> Container:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get a container by its primary key.
 
     This returns the Container, not any specific version. It may not be published, or may have been soft deleted.
@@ -559,7 +551,6 @@ def get_container(pk: Container.ID) -> Container:
 
 def get_container_version(container_version_pk: int) -> ContainerVersion:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get a container version by its primary key.
 
     Args:
@@ -573,7 +564,6 @@ def get_container_version(container_version_pk: int) -> ContainerVersion:
 
 def get_container_by_code(learning_package_id: LearningPackage.ID, /, container_code: str) -> Container:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get a container by its learning package and container code.
 
     Args:
@@ -639,7 +629,6 @@ def get_containers(
     include_deleted: bool | None = False,
 ) -> QuerySet[Container]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get all containers in the given learning package.
 
     Args:
@@ -667,7 +656,6 @@ def get_entities_in_container(
     select_related_version: str | None = None,
 ) -> list[ContainerEntityListEntry]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get the list of entities and their versions in the current draft or
     published version of the given container.
 
@@ -726,7 +714,6 @@ def get_entities_in_container_as_of(
     publish_log_id: int,
 ) -> tuple[ContainerVersion | None, list[ContainerEntityListEntry]]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get the list of entities and their versions in the published version of the
     given container as of the given PublishLog version (which is essentially a
     version for the entire learning package).
@@ -760,7 +747,6 @@ def get_entities_in_container_as_of(
 
 def contains_unpublished_changes(container_or_pk: Container | Container.ID, /) -> bool:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Check recursively if a container has any unpublished changes.
 
     Note: I've preserved the API signature for now, but we probably eventually
@@ -813,7 +799,6 @@ def get_containers_with_entity(
     published=False,
 ) -> QuerySet[Container]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Find all draft containers that directly contain the given entity.
 
     They will always be from the same learning package; cross-package containers
@@ -854,7 +839,6 @@ def get_container_children_count(
     published: bool,
 ):
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get the count of entities in the current draft or published version of the given container.
 
     Args:
@@ -892,7 +876,6 @@ def get_container_children_entity_refs(container_version: ContainerVersion) -> l
 
 def get_descendant_component_entity_ids(container: Container) -> list[int]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Return the entity IDs of all leaf (non-Container) descendants of ``container``.
 
     Intermediate containers (e.g. Subsections, Units) are never included in the

src/openedx_content/applets/publishing/api.py

@@ -601,7 +601,6 @@ def get_entity_draft_history(
     publishable_entity_or_id: PublishableEntity | int, /
 ) -> QuerySet[DraftChangeLogRecord]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Return DraftChangeLogRecords for a PublishableEntity since its last publication,
     ordered from most recent to oldest.
 
@@ -669,7 +668,6 @@ def get_entity_publish_history(
     publishable_entity_or_id: PublishableEntity | int, /
 ) -> QuerySet[PublishLogRecord]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Return all PublishLogRecords for a PublishableEntity, ordered most recent first.
 
     Edge cases:
@@ -704,7 +702,6 @@ def get_entity_publish_history_entries(
     publish_log_uuid: str,
 ) -> QuerySet[DraftChangeLogRecord]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Return the DraftChangeLogRecords associated with a specific PublishLog.
 
     Finds the PublishLogRecord for the given entity and publish_log_uuid, then
@@ -802,7 +799,6 @@ def get_entity_version_contributors(
     new_version_num: int | None,
 ) -> QuerySet:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Return distinct User queryset of contributors (changed_by) for
     DraftChangeLogRecords of a PublishableEntity after old_version_num.
 

src/openedx_content/applets/sections/api.py

@@ -91,7 +91,6 @@ def create_next_section_version(
 @dataclass(frozen=True)
 class SectionListEntry:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Data about a single subsection in a section.
     """
 
@@ -109,7 +108,6 @@ def get_subsections_in_section(
     published: bool,
 ) -> list[SectionListEntry]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get the list of entities and their versions in the draft or published
     version of the given Section.
 

src/openedx_content/applets/subsections/api.py

@@ -91,7 +91,6 @@ def create_next_subsection_version(
 @dataclass(frozen=True)
 class SubsectionListEntry:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Data about a single unit in a subsection.
     """
 
@@ -109,7 +108,6 @@ def get_units_in_subsection(
     published: bool,
 ) -> list[SubsectionListEntry]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get the list of entities and their versions in the draft or published
     version of the given Subsection.
 

src/openedx_content/applets/units/api.py

@@ -91,7 +91,6 @@ def create_next_unit_version(
 @dataclass(frozen=True)
 class UnitListEntry:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Data about a single entity in a container, e.g. a component in a unit.
     """
 
@@ -109,7 +108,6 @@ def get_components_in_unit(
     published: bool,
 ) -> list[UnitListEntry]:
     """
-    [ ❓TODO: STABLE or UNSTABLE? ]
     Get the list of entities and their versions in the draft or published
     version of the given Unit.