Samuel
@samuel.fm
documentation is a side effect which is why functional programmers avoid it at all costs
5 8 33
Alona
haskell fans be like: what part of `>>= :: (Monad m) => m a -> (a -> m b) -> m b` was unclear? what more documentation could you possibly need?
1 6 30
Alona
how would you document the `Monad` typeclass overall? How much should go their, vs being assumed FP knowledge?
2 3
Alona
(this is a completely sincere question, which i realize may not be clear from my highly insincere post above it)
1 3
xormetric
depends on what role you want documentation to serve. I'd say the best way to learn about Monad is reading real-world examples. the community can write tutorials; the official documentation should be a reference of what's not conveyed by types e.g. the monad laws and how do-notation is desugared.
1
Barry Dorrans
My security reviews and threat models force public documentation of security assumptions. Because I’m a bad person to my devs.
1 4
Barry Dorrans
To be fair over the last 10 years it’s gotten a lot easier as they know the expectations and they’re thinking about the security implications of their apis. But it’s kinda fun to explain it to a new dev or pm, and no, it has to be done before any preview release.
1 3
Barry Dorrans
There are days when I wonder if what I do is worthwhile and then someone comes to me with questions they’ve prepared for and thought through potential security problems and solutions.
1 2
Barry Dorrans
But the real fun is intern security reviews. Our interns write real code which can become part of the product so midway through they get a security review and I won’t give them answers, I give them research so they can figure it out. Usually works too, sometimes it’s too niche and I guide them.
2