ZacharyZhang-NY
e74dafcd36
Three independently ugly bugs that all fed the same log flood:
* Electron's `WebFrameMain.send` writes every "Render frame was disposed"
to stderr via `console.error`. When the worker fans a second
agent-event past a reloading renderer, we produced thousands of
identical lines and stalled the main loop on stderr I/O. Added a
`mainFrame.detached` guard so the send is short-circuited before
Electron's own catch block fires, and installed a targeted filter in
`suppress-warnings.ts` (now actually imported from the entry point)
so the specific `console.error("Error sending from webFrameMain:"…)`
noise never reaches the terminal. Any other payload still surfaces.
* `dispatchAgentMessage` accepted the human-reader sentinel as a wake
target when an agent replied to `__board__` — `wakeAgentIfPossible`
then called `db.getAgent("__board__")`, threw, and the dispatcher
kept repeating on every send. Strip `HUMAN_SENDER_ID` at
`resolveMessageWakeTargets`, and keep a defense-in-depth guard in the
heartbeat so a stray caller (future automation fan-out) cannot
reintroduce the crash.
* Pi's skills loader rejects any SKILL.md whose frontmatter `name`
diverges from its parent directory. The four bundled `my-writing-style`
copies declared `name: writing-style-skill`, so every install emitted
a warning and dropped the skill. They also lived as orphan gitlinks
(mode 160000 without .gitmodules), and the global `*.md` gitignore
hid every other SKILL.md from version control. Fixed the frontmatter
to match the dir, converted the dangling submodules to plain trees,
and allowlisted `builtin-skills/**/*.md` so a fresh clone carries the
catalogue instead of silently losing it.
1.6 KiB
1.6 KiB
title, impact, impactDescription, tags
| title | impact | impactDescription | tags |
|---|---|---|---|
| Use Comments to Explain Intent | HIGH | preserves decision rationale for future readers | cmt, intent, why, rationale |
Use Comments to Explain Intent
Good comments explain WHY, not WHAT. The code already tells you what it does. Comments should explain the reasoning behind a decision that cannot be expressed in code.
Incorrect (narrating the code):
// Increment counter by 1
counter++;
// Loop through all employees
for (Employee employee : employees) {
// Check if employee is active
if (employee.isActive()) {
// Add employee to list
activeEmployees.add(employee);
}
}
// Set the name
this.name = name;
Correct (explaining intent):
// We use insertion sort here because the list is almost always nearly sorted,
// and insertion sort is O(n) for nearly sorted data vs O(n log n) for quicksort
insertionSort(nearlyOrderedList);
// Format matches the external API's expected date format (ISO 8601 without timezone)
// See: https://api.vendor.com/docs/date-format
String formattedDate = date.format(DateTimeFormatter.ISO_LOCAL_DATE);
// Bias toward newer sessions - users expect recent data first
// Business requirement from Product (ticket PROD-1234)
sessions.sort(Comparator.comparing(Session::getCreatedAt).reversed());
Good comment situations:
- Legal comments (copyright, license)
- Explanation of intent or rationale
- Clarification of obscure API behavior
- Warning of consequences
- TODO comments (temporary)
Reference: Clean Code, Chapter 4: Comments