Skip to content

Commit b07afc5

Browse files
committed
docs: Fix RTD block errors in docstrings
1 parent 0a09282 commit b07afc5

3 files changed

Lines changed: 4 additions & 15 deletions

File tree

src/openedx_content/applets/containers/api.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -888,10 +888,8 @@ def get_descendant_component_entity_ids(container: Container) -> list[int]:
888888
889889
- A container whose draft was soft-deleted has no children to traverse and
890890
contributes no entity IDs.
891-
892891
- An entity that appears as a child of multiple containers is deduplicated
893892
because the result is built from a set.
894-
895893
- A cycle-guard (``visited_container_pks``) prevents infinite loops, which
896894
cannot occur in practice but is included for safety.
897895
"""

src/openedx_content/applets/publishing/api.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -627,16 +627,12 @@ def get_entity_draft_history(
627627
Edge cases:
628628
629629
- Never published, no versions: returns an empty queryset.
630-
631630
- Never published, has versions: returns all DraftChangeLogRecords.
632-
633631
- No changes since the last publish: returns an empty queryset.
634-
635632
- Last publish was a soft-delete (Published.version=None): the Published row
636633
still exists and its published_at timestamp is used as the lower bound, so
637634
only draft changes made after that soft-delete publish are returned. If
638635
there are no subsequent changes, the queryset is empty.
639-
640636
- Unpublished soft-delete (soft-delete in draft, not yet published): the
641637
soft-delete DraftChangeLogRecord (new_version=None) is included because
642638
it was made after the last real publish.
@@ -698,11 +694,9 @@ def get_entity_publish_history(
698694
Edge cases:
699695
700696
- Never published: returns an empty queryset.
701-
702697
- Soft-delete published (new_version=None): the record is included with
703698
old_version pointing to the last published version and new_version=None,
704699
indicating the entity was removed from the published state.
705-
706700
- Multiple draft versions created between two publishes are compacted: each
707701
PublishLogRecord captures only the version that was actually published,
708702
not the intermediate draft versions.
@@ -747,7 +741,6 @@ def get_entity_publish_history_entries(
747741
- Each publish group is independent: only the DraftChangeLogRecords that
748742
belong to the requested publish_log_uuid are returned; changes attributed
749743
to other publish groups are excluded.
750-
751744
- Soft-delete publish (PublishLogRecord.new_version=None): the soft-delete
752745
DraftChangeLogRecord (new_version=None) is included in the entries because
753746
it falls within the time window of that publish group.
@@ -843,10 +836,8 @@ def get_entity_version_contributors(
843836
Edge cases:
844837
845838
- If no DraftChangeLogRecords fall in the range, returns an empty queryset.
846-
847839
- Records with changed_by=None (system changes with no associated user) are
848840
always excluded.
849-
850841
- A user who contributed multiple versions in the range appears only once
851842
(results are deduplicated with DISTINCT).
852843
"""

src/openedx_content/applets/publishing/models/publishable_entity.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ class PublishableEntity(models.Model):
8383
model instead of storing them in those other models? Two reasons:
8484
8585
* Published things need to have the right identifiers so they can be used
86-
throughout the system, and the UUID is serving the role of ISBN in physical
87-
book publishing.
86+
throughout the system, and the UUID is serving the role of ISBN in physical
87+
book publishing.
8888
* We want to be able to enforce the idea that "entity_ref" is locally unique across
89-
all PublishableEntities within a given LearningPackage. Component and Unit
90-
can't do that without a shared model.
89+
all PublishableEntities within a given LearningPackage. Component and Unit
90+
can't do that without a shared model.
9191
9292
That being said, models that build on PublishableEntity are free to add
9393
their own identifiers if it's useful to do so.

0 commit comments

Comments
 (0)