Science Memes

14383 readers

1754 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

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

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

Research Committee

[email protected]

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

[email protected]

161

spaghett. (mander.xyz)

submitted 3 weeks ago by [email protected] to c/[email protected]

3 comments fedilink hide all child comments

top 3 comments

sorted by: hot top controversial new old

[–] [email protected] 17 points 3 weeks ago

I've seen worse.

[–] [email protected] 3 points 3 weeks ago (1 children)

Are other auto code documentation tools better? I always figure, it's mostly a matter of leaving out the details to make it understandable. And that's kind of a hard thing to find heuristics for.

[–] [email protected] 13 points 3 weeks 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.