A photo of me wearing a blue blazer and pocket square while on a horse, looking quite dapper.

David Celis

A cowboy coder.

Follow me

i strive to write code that’s readable enough not to need code comments… but when you’re dealing with time and duration, it’s really difficult to keep things straight. i’ve been working with time a lot as i work on FireHydrant’s upcoming on-call product, and something i’ve been adding a lot to my code that deals with time is visual comments. for example, take this test about requesting coverage. the intended result is visible at a glance without having to juggle eight timestamps in your head!

A code snippet showing a specification test. The scenario involves requesting on-call coverage during a one week period, with three on-call shifts being affected by that request. The first shift starts before the period but overlaps with the beginning. The second shift is right in the middle of the period. The last shift, like the first, overlaps with the end of the period. The coverage request, three shifts, and expected result of the coverage request are all laid out in a code comment that display as a timeline.
/ 🦋 / 🦣 Highland / Denver / CO 50°F and cloudy  (AQI 15 )

Did you like this post, repost it, or respond to it? Let me know by sending a webmention!

🌐
3

💬 Replies (1)

wilson :nix_snowflake_logo:

@davidcelis i'm also big fan of visual comments + capturing context in test comments. i know i'd totally appreciate stumbling into something like this :)