Skip to content

Commit 626d2a4

Browse files
refactor: render triggers only when trigger fields are available
1 parent a07eb00 commit 626d2a4

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

code_annotations/contrib/sphinx/extensions/openedx_events.py

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ def iter_nodes(self):
100100
event_key_field = event.get(".. event_key_field:", "")
101101
event_key_literal = nodes.literal(text=event_key_field)
102102
event_description = event[".. event_description:"]
103-
event_trigger_repository = event.get(".. event_trigger_repository:", "").split(" ")
104-
event_trigger_path = event.get(".. event_trigger_path:", "").split(" ")
103+
event_trigger_repository = event.get(".. event_trigger_repository:")
104+
event_trigger_path = event.get(".. event_trigger_path:")
105105

106106
event_section = nodes.section("", ids=[f"openedxevent-{event_type}"])
107107
event_section += nodes.title(text=event_type, ids=[f"title-{event_type}"])
@@ -132,22 +132,25 @@ def iter_nodes(self):
132132
ids=[f"definition-{event_name}"],
133133
)
134134

135-
event_section += nodes.paragraph(text="Triggers", ids=[f"triggers-{event_name}"])
136-
triggers_bullet_list = nodes.bullet_list()
137-
for repository, path in zip(event_trigger_repository, event_trigger_path):
138-
triggers_bullet_list += nodes.list_item(
139-
"",
140-
nodes.paragraph(
135+
if event_trigger_path and event_trigger_repository:
136+
event_trigger_path = event_trigger_path.split(" ")
137+
event_trigger_repository = event_trigger_repository.split(" ")
138+
event_section += nodes.paragraph(text="Triggers", ids=[f"triggers-{event_name}"])
139+
triggers_bullet_list = nodes.bullet_list()
140+
for repository, path in zip(event_trigger_repository, event_trigger_path):
141+
triggers_bullet_list += nodes.list_item(
141142
"",
142-
"Path: ",
143-
nodes.reference(
144-
text=path,
145-
refuri=f"https://github.com/search?q=repo:{repository}+{event_name}+path:{path}"
143+
nodes.paragraph(
144+
"",
145+
"Path: ",
146+
nodes.reference(
147+
text=path,
148+
refuri=f"https://github.com/search?q=repo:{repository}+{event_name}+path:{path}"
149+
),
146150
),
147-
),
148-
)
151+
)
149152

150-
event_section += triggers_bullet_list
153+
event_section += triggers_bullet_list
151154

152155
if event.get(".. event_warning:") not in (None, "None", "n/a", "N/A"):
153156
event_section += nodes.warning(

0 commit comments

Comments
 (0)