From 417e61d0e4d45f85f26da7c9f3f0950ef4b42600 Mon Sep 17 00:00:00 2001 From: Navin Karkera Date: Mon, 4 Nov 2024 10:00:40 +0530 Subject: [PATCH] refactor: apply suggestions Co-authored-by: Maria Grimaldi --- docs/how-tos/adding-events-to-event-bus.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/how-tos/adding-events-to-event-bus.rst b/docs/how-tos/adding-events-to-event-bus.rst index 339494c5..89e45da1 100644 --- a/docs/how-tos/adding-events-to-event-bus.rst +++ b/docs/how-tos/adding-events-to-event-bus.rst @@ -21,10 +21,10 @@ In the producing/host application, include ``openedx_events`` in ``INSTALLED_APP # .. setting_name: EVENT_BUS_PRODUCER_CONFIG # .. setting_default: {} - # .. setting_description: Dictionary of event_types to dictionaries for topic related configuration. - # Each topic configuration dictionary uses the topic as a key and contains a flag called `enabled` - # denoting whether the event will be and `event_key_field` which is a period-delimited string path - # to event data field to use as event key. + # .. setting_description: Dictionary of event_types to dictionaries for topic-related configuration. + # Each topic configuration dictionary uses the topic as a key and contains: + # * A flag called `enabled` denoting whether the event will be published. + # * The `event_key_field` which is a period-delimited string path to event data field to use as event key. # Note: The topic names should not include environment prefix as it will be dynamically added based on # EVENT_BUS_TOPIC_PREFIX setting. EVENT_BUS_PRODUCER_CONFIG = {