Skip to content

Commit acd824c

Browse files
committed
fix: Use straight quote instead of curly
1 parent 16155e7 commit acd824c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/how-tos/add-event-bus-support-to-an-event.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ By default, Open edX Events should be compatible with the Open edX Event Bus. Ho
1919
When adding support is not possible, do the following:
2020

2121
- Add it to the ``KNOWN_UNSERIALIZABLE_SIGNALS`` list in the ``openedx_events/tooling.py`` file so the event bus ignores it.
22-
- Add a ``warning`` in the events docstring to inform developers why the event is incompatible with the event bus.
22+
- Add a ``warning`` in the event's docstring to inform developers why the event is incompatible with the event bus.
2323

2424
If you don't add the event to the ``KNOWN_UNSERIALIZABLE_SIGNALS`` list, the CI/CD pipeline will fail because the missing Avro schema could not be generated for the :term:`Event Payload`. If you don't add a warning in the event's docstring, developers might try to send the event across services and encounter issues.
2525

0 commit comments

Comments
 (0)