Skip to content

Commit

Permalink
docs: fix entrypoint syntax in overrides tutorial
Browse files Browse the repository at this point in the history
In an entrypoint, the module path and the object name
need to be separated by a single colon, not a double colon.
  • Loading branch information
kdmccormick authored Aug 19, 2024
1 parent 2082432 commit 9daa066
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/xblock-tutorial/edx_platform/overrides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ Imagine there is an XBlock installed ``edx-platform``:
# edx-platform/xblocks/video_block.py
class VideoBlock(XBlock):
...
...
# edx-platform/setup.py
setup(
# ...
entry_points={
"xblock.v1": [
"video = xblocks.video_block::VideoBlock"
"video = xblocks.video_block:VideoBlock"
# ...
]
}
Expand All @@ -50,14 +50,14 @@ If you then create your own Python package with a custom version of that XBlock.
# your_plugin/xblocks/video_block.py
class YourVideoBlock(XBlock):
...
...
# your_plugin/setup.py
setup(
# ...
entry_points={
"xblock.v1.overrides": [
"video = your_plugin.xblocks.video_block::YourVideoBlock"
"video = your_plugin.xblocks.video_block:YourVideoBlock"
# ...
],
}
Expand Down

0 comments on commit 9daa066

Please sign in to comment.