se-edu / guides

Style guides and tutorials for SE student projects
MIT License
5 stars 19 forks source link

[AB3: Tracing Code]: Clarify what Event Driven Mechanisms is #34

Open tayruxin opened 1 week ago

tayruxin commented 1 week ago

Current:

image

Problem: Students might not understand what it means by “various event-driven mechanisms” and may be confused on the choice of placing the breakpoint where the UI transfer controls to the logic component.

Proposed: Add a paragraph after the highlighted part:

This is because, unlike linear command-line programs, GUI applications respond to user actions (like clicks and keystrokes) and other events, triggering various event listeners and handlers. This non-linear flow of control can make it difficult to trace and debug the sequence of operations, as the program reacts dynamically to different events, creating an obscure execution path.

damithc commented 1 week ago

@tayruxin I've added this extra info as a tooltip, in https://se-education.org/guides/tutorials/ab3TracingCode.html so that only those who are unfamiliar with the term can read the additional info. Does that a good-enough solution?

tayruxin commented 1 day ago

I think that will be a good solution as it does not make the whole tutorial lengthy and students who are unsure can refer to the additional information.