this post was submitted on 03 Apr 2025
159 points (98.8% liked)

Science Memes

13982 readers
2635 users here now

Welcome to c/science_memes @ Mander.xyz!

A place for majestic STEMLORD peacocking, as well as memes about the realities of working in a lab.



Rules

  1. Don't throw mud. Behave like an intellectual and remember the human.
  2. Keep it rooted (on topic).
  3. No spam.
  4. Infographics welcome, get schooled.

This is a science community. We use the Dawkins definition of meme.



Research Committee

Other Mander Communities

Science and Research

Biology and Life Sciences

Physical Sciences

Humanities and Social Sciences

Practical and Applied Sciences

Memes

Miscellaneous

founded 2 years ago
MODERATORS
 
you are viewing a single comment's thread
view the rest of the comments
[–] kattfisk@lemmy.dbzer0.com 13 points 22 hours ago

I've yet to see any that are of any use.

A pet peeve of mine is documentation that describes how the code works. If I want to know that, I can just read it (perhaps assisted by an IDE or debugger).*

What I need documented is why the code works like that. How is it intended to be used? What quirks and gotchas are there?

*If the code is not readable it needs to be refactored, not documented.