this post was submitted on 11 Feb 2026
-3 points (36.4% liked)

Programming

25463 readers
302 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities !webdev@programming.dev

founded 2 years ago
MODERATORS
snowe@programming.dev
Ategon@programming.dev
UlrikHD@programming.dev
bugsmith@programming.dev
Spyro@programming.dev
-3
Ship types, not docs (shiptypes.com)
submitted 1 day ago by codeinabox@programming.dev to c/programming@programming.dev
11 comments fedilink hide all child comments
 

cross-posted from: https://lemmy.bestiver.se/post/919071

Comments

you are viewing a single comment's thread
view the rest of the comments
[–] CombatWombatEsq@lemmy.world 13 points 1 day ago (1 children)

The point is not "never write documentation." Types tell you what: the shape of requests and responses, the valid values, the required fields. You still write prose for why a system exists, when to use it, and how it fits into the bigger picture.

Idk, that sounds like a pretty clear case for shipping types and docs, rather than types instead of docs? Maybe you could even output your type data from your build system into the documentation on every release so they’re never out of date?

[–] FizzyOrange@programming.dev 1 points 21 hours ago

This has been the norm for literally decades. Doxygen was doing it in 1997 and I'm sure it wasn't the first.