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.
53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
---
|
|
title: Maximize Expressiveness
|
|
impact: MEDIUM-HIGH
|
|
impactDescription: reduces time to understand unfamiliar code by 50%+
|
|
tags: emerge, expressiveness, readability, maintenance
|
|
---
|
|
|
|
## Maximize Expressiveness
|
|
|
|
The majority of the cost of a software project is in long-term maintenance. Write code for the reader, not the writer. The clearer the author can make the code, the less time others will spend understanding it.
|
|
|
|
**Incorrect (clever but opaque):**
|
|
|
|
```java
|
|
// Bit manipulation for no reason
|
|
public boolean isWeekend(int day) {
|
|
return ((day & 0x6) == day) && (day > 0);
|
|
}
|
|
|
|
// Terse variable names in complex logic
|
|
public int calc(int[] a, int n) {
|
|
int r = 0;
|
|
for (int i = 0; i < n; i++)
|
|
r = Math.max(r, a[i] - (i > 0 ? a[i-1] : 0));
|
|
return r;
|
|
}
|
|
```
|
|
|
|
**Correct (clear and expressive):**
|
|
|
|
```java
|
|
public boolean isWeekend(DayOfWeek day) {
|
|
return day == DayOfWeek.SATURDAY || day == DayOfWeek.SUNDAY;
|
|
}
|
|
|
|
public int findMaxDailyGain(int[] dailyPrices, int numberOfDays) {
|
|
int maxGain = 0;
|
|
for (int day = 1; day < numberOfDays; day++) {
|
|
int dailyChange = dailyPrices[day] - dailyPrices[day - 1];
|
|
maxGain = Math.max(maxGain, dailyChange);
|
|
}
|
|
return maxGain;
|
|
}
|
|
```
|
|
|
|
**Techniques for expressiveness:**
|
|
- Choose good names (the single most effective technique)
|
|
- Keep functions and classes small and focused
|
|
- Use standard patterns and nomenclature — when you use the Strategy pattern, name the class with "Strategy" so readers recognize the intent
|
|
- Write well-crafted unit tests — tests are documentation by example
|
|
|
|
Reference: [Clean Code, Chapter 12: Emergence](https://www.oreilly.com/library/view/clean-code-a/9780136083238/)
|