Repository navigation
fix: declare multi_device support on Word Cloud student_view - #335
irfanuddinahmad wants to merge 1 commit into
Conversation
The built-in openedx-platform Word Cloud block declared
`@XBlock.supports("multi_device")` on `student_view`, but the extracted
block didn't. The course blocks API reports it as
`student_view_multi_device`, so without it mobile apps stop rendering the
block inline. Restore the declaration and add a regression test.
Found during review of openedx/openedx-platform#38745.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Thanks for the pull request, @irfanuddinahmad! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Summary
The built-in Word Cloud block in openedx-platform declares
@XBlock.supports("multi_device")onstudent_view(xmodule/word_cloud_block.py:255on master). The extracted block doesn't.The platform's course blocks API reads this flag (
lms/djangoapps/course_api/blocks/transformers/student_view.py,block.has_support(student_view, 'multi_device')) and reports it asstudent_view_multi_device. Without it, mobile apps stop rendering Word Cloud inline once the built-in block is removed.Reported by @farhan in review of openedx/openedx-platform#38745 (slash-n-burn, epic openedx/openedx-platform#37819).
Changes
src/xblock_word_cloud/block.py: add@XBlock.supports("multi_device")tostudent_view.src/xblock_word_cloud/tests/test_word_cloud.py: addtest_student_view_supports_multi_device.I checked the other extracted blocks against their built-in versions. Only Word Cloud lost this flag: HTML and Problem keep theirs, and the other blocks never declared it.
Test plan
uv run --frozen pytest src/xblock_word_cloud/tests/test_word_cloud.py: 9 passed. The new test fails without the fix.ruff check/ruff format --check: clean.🤖 Generated with Claude Code