4min chapter

Overtired cover image

329: I Am Not a Linter!

Overtired

CHAPTER

How to Denote an API in a Modular Way

The more modular something is the easier it is to grok exactly what's happening in a method. Comments can explain literally everything that happens in a function, and if you use like chat GPT to write your comments for you, it will. But when I'm reading somebody else's code, I'm usually doing it with enough knowledge to glance at a block of code and understand what it's doing and how it's doing it. And the comments for me should just serve to it should be like one or two lines that denote here's here's what I did here.

00:00

Get the Snipd
podcast app

Unlock the knowledge in podcasts with the podcast player of the future.
App store bannerPlay store banner

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode

Save any
moment

Hear something you like? Tap your headphones to save it with AI-generated key takeaways

Share
& Export

Send highlights to Twitter, WhatsApp or export them to Notion, Readwise & more

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode