Skip to content

Commit ca462ee

Browse files
david-pmuohzxela
authored andcommitted
Add a short description under "Function names should say what they do"
1 parent 143ef1c commit ca462ee

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,8 @@ email_clients(active_clients(clients))
293293
**[⬆ back to top](#table-of-contents)**
294294

295295
### Function names should say what they do
296+
Poorly named methods add to the code reviewer's cognitive load at best, and mislead the
297+
code reviewer at worst. Strive to capture the the precise intent when naming methods.
296298

297299
**Bad:**
298300
```ruby

0 commit comments

Comments
 (0)