Skip to content
loading...

re: What makes maintaining documentation difficult? VIEW POST

TOP OF THREAD FULL DISCUSSION
re: Code can't lie, documentation can. It's sooo easy to get them out of sync.
 

code tells exactly what it does. sometimes it's not what you expect, though

Only when working solely with primitive operators that cannot be overloaded. Otherwise, code can easily lie. There is no shortage of methods like getFoo(), that only retrieves the latest 5 foo (unless it’s a Tuesday), but also removes the oldest foo, sends some random administrator a loosely related email, and might possible do a perfect frontflip and backflip to wrap things up (though not always, and we’ve yet to figure out why it doesn’t do the backflip before the frontflip).

code of conduct - report abuse