Skip to content

Commit f82bf19

Browse files
refactor: drop path from trigger details for more maintainable approach
1 parent 626d2a4 commit f82bf19

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

code_annotations/contrib/config/openedx_events_annotations.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ annotations:
1313
- ".. event_data:":
1414
- ".. event_key_field:":
1515
- ".. event_trigger_repository:":
16-
- ".. event_trigger_path:":
1716
- ".. event_warning:":
1817
extensions:
1918
python:

code_annotations/contrib/sphinx/extensions/openedx_events.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ def iter_nodes(self):
101101
event_key_literal = nodes.literal(text=event_key_field)
102102
event_description = event[".. event_description:"]
103103
event_trigger_repository = event.get(".. event_trigger_repository:")
104-
event_trigger_path = event.get(".. event_trigger_path:")
105104

106105
event_section = nodes.section("", ids=[f"openedxevent-{event_type}"])
107106
event_section += nodes.title(text=event_type, ids=[f"title-{event_type}"])
@@ -132,20 +131,19 @@ def iter_nodes(self):
132131
ids=[f"definition-{event_name}"],
133132
)
134133

135-
if event_trigger_path and event_trigger_repository:
136-
event_trigger_path = event_trigger_path.split(" ")
134+
if event_trigger_repository:
137135
event_trigger_repository = event_trigger_repository.split(" ")
138136
event_section += nodes.paragraph(text="Triggers", ids=[f"triggers-{event_name}"])
139137
triggers_bullet_list = nodes.bullet_list()
140-
for repository, path in zip(event_trigger_repository, event_trigger_path):
138+
for repository in event_trigger_repository:
141139
triggers_bullet_list += nodes.list_item(
142140
"",
143141
nodes.paragraph(
144142
"",
145-
"Path: ",
143+
"Event triggered by ",
146144
nodes.reference(
147-
text=path,
148-
refuri=f"https://github.com/search?q=repo:{repository}+{event_name}+path:{path}"
145+
text=repository,
146+
refuri=f"https://github.com/search?q=repo:{repository}+{event_name}.send_event&type=code",
149147
),
150148
),
151149
)

0 commit comments

Comments
 (0)