Skip to content

Commit

Permalink
fix: Use straight quote instead of curly
Browse files Browse the repository at this point in the history
  • Loading branch information
sarina committed Feb 13, 2025
1 parent 16155e7 commit acd824c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/how-tos/add-event-bus-support-to-an-event.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ By default, Open edX Events should be compatible with the Open edX Event Bus. Ho
When adding support is not possible, do the following:

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

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.

Expand Down

0 comments on commit acd824c

Please sign in to comment.