feat: Add a config for openedx-events annotations

openedx · Feb 20, 2024 · 850622c · 850622c
1 parent d99bb11
commit 850622c
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/code_annotations/contrib/sphinx/extensions/openedx_events.py b/code_annotations/contrib/sphinx/extensions/openedx_events.py
@@ -87,7 +87,7 @@ def iter_nodes(self):
             event_name = event[".. event_name:"]
             event_name_literal = nodes.literal(text=quote_value(event_name))
             event_data = event[".. event_data:"]
-            event_key_field = event.get(".. event_key_field:", None)
+            event_key_field = event.get(".. event_key_field:", "")
             event_key_literal = nodes.literal(text=quote_value(event_key_field))
             event_description = event[".. event_description:"]
 
@@ -97,11 +97,11 @@ def iter_nodes(self):
             if event_key_field:
                 event_section += nodes.paragraph(
                     "",
-                    "Event key field:",
+                    "Event key field: ",
                     event_key_literal
                 )
-            event_section += nodes.paragraph(text=f"Description:"
-                                                  f" {event_description}")
+            event_section += nodes.paragraph(text=f"Description: "
+                                                  f"{event_description}")
             event_section += nodes.paragraph(text=f"Event data: {event_data}")
             event_section += nodes.paragraph(
                 text=f"Defined at: {event['filename']} (line"