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.
56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
---
|
|
title: Use Verb Phrases for Method Names
|
|
impact: MEDIUM-HIGH
|
|
impactDescription: reduces "what does this method do" lookups by 80%
|
|
tags: name, method, verb, action
|
|
---
|
|
|
|
## Use Verb Phrases for Method Names
|
|
|
|
Method names should be verbs or verb phrases. Methods do things, so their names should say what they do. Follow JavaBean conventions for accessors and mutators.
|
|
|
|
**Incorrect (non-verb or unclear):**
|
|
|
|
```java
|
|
// Noun names for methods
|
|
public String name() {}
|
|
public int size() {} // Acceptable for collections
|
|
|
|
// Unclear action
|
|
public void customer() {} // Does what to customer?
|
|
|
|
// Missing verb
|
|
public boolean valid() {}
|
|
```
|
|
|
|
**Correct (verb phrases):**
|
|
|
|
```java
|
|
// Clear verb phrases
|
|
public void postPayment() {}
|
|
public void deletePage() {}
|
|
public void saveCustomer() {}
|
|
|
|
// Accessors, mutators, predicates follow conventions
|
|
public String getName() {}
|
|
public void setName(String name) {}
|
|
public boolean isPosted() {}
|
|
public boolean hasPermission() {}
|
|
|
|
// Static factory methods describe what is created
|
|
Complex fulcrumPoint = Complex.fromRealNumber(23.0);
|
|
```
|
|
|
|
Use `get`, `set`, `is`, and `has` prefixes consistently for accessors, mutators, and predicates.
|
|
|
|
**Language-specific conventions:**
|
|
- **Java/C#:** `getName()`, `setName()`, `isActive()` (JavaBean conventions)
|
|
- **Python:** Use `@property` decorators — `user.name` not `user.get_name()`
|
|
- **Kotlin/Swift:** Direct property access with `val`/`var` — `user.name` not `user.getName()`
|
|
- **TypeScript:** Direct properties or getters — `get name(): string`
|
|
- **Go:** `Name()` not `GetName()` (Go convention omits `Get` prefix)
|
|
|
|
The underlying principle (methods describe actions, names describe things) is universal. The accessor/mutator conventions are language-specific.
|
|
|
|
Reference: [Clean Code, Chapter 2: Meaningful Names](https://www.oreilly.com/library/view/clean-code-a/9780136083238/)
|