this post was submitted on 12 Dec 2023
807 points (99.0% liked)

Programmer Humor

19623 readers
2719 users here now

Welcome to Programmer Humor!

This is a place where you can post jokes, memes, humor, etc. related to programming!

For sharing awful code theres also Programming Horror.

Rules

founded 1 year ago
MODERATORS
Feyter@programming.dev
anzo@programming.dev
BurningTurtle@programming.dev
pylapp@programming.dev
807
Manager: This task only takes 30 minutes. Why did it take you the whole day? (programming.dev)
submitted 11 months ago by hypnotic_nerd@programming.dev to c/programmer_humor@programming.dev
102 comments fedilink hide all child comments
 
you are viewing a single comment's thread
view the rest of the comments
[–] KeepFlying@lemmy.world 1 points 11 months ago (1 children)

Code comments for "why"s that persist. Commits for why's that are temporary.

If you need to run X before Y, add a comment. If you added X before why because it was easier, leave it in a commit

[–] deadbeef79000@lemmy.nz 2 points 11 months ago (1 children)

If you need to run X before Y...

Add a test that asserts that.

[–] KeepFlying@lemmy.world 2 points 11 months ago

With a comment on the test detailing why it matters so people don't just assume the test is out of date when it fails.

And ideally test the underlying result of x before y, not the fact that x is called before y.

And while we're at it, assert in Y that X has been called, and again comment the reason for the preconditions.