News for hackers. Stuff that matters.
Re:Redis scripts do not expire keys atomically by staticassertion on Thursday January 27, 2022 @08:41AM (#30100418)
Not who you're asking but... why have documentation at all? So that we don't have to read source code.
Re:Redis scripts do not expire keys atomically by c0l0 on Thursday January 27, 2022 @08:50AM (#30100515)
Because documentation is what is needs to be: A simplified and necessarily incomplete description of program behavior. It's a trade-off, since a complete and exhaustive description of all intricacies of potential program behavior would be at least as complex as the definition (= its source code) of said program.

If you happen to have a question that ends up on the wrong side of that trade-off between documentation's completeness and accessibility, you will have to descend into the depths that lie beneath. I believe the redis documentation actually strikes a rather OK balance in that regard.

Re:Redis scripts do not expire keys atomically by staticassertion on Thursday January 27, 2022 @10:09AM (#30101434)
Good docs generally make guarantees and pitfalls clear.
Re:Redis scripts do not expire keys atomically by scraptor on Thursday January 27, 2022 @09:31AM (#30100996)
Of course having documentation is better but that's not a reason not to read the source code if the documentation isn't enough.
Re:Redis scripts do not expire keys atomically by voidfunc on Thursday January 27, 2022 @09:51AM (#30101240)
Because good docs are like a good search engine: high hit rate for what you want most of the time.

The edge cases and quirky impl detail questions are what src is for.

Re:Redis scripts do not expire keys atomically by megapolitics on Thursday January 27, 2022 @10:33AM (#30101737)
I would argue that outlining expected behaviour in edge cases is one of the most important topics for documentation to cover.
Re:Redis scripts do not expire keys atomically by staticassertion on Thursday January 27, 2022 @10:58AM (#30102071)
> The edge cases and quirky impl detail questions are what src is for.

Literally the most important thing you can document.

Re:Redis scripts do not expire keys atomically by edf13 on Thursday January 27, 2022 @08:45AM (#30100460)
You can’t cover every usage possibility in docs… having the code available allows you to check expected behaviour
Re:Redis scripts do not expire keys atomically by rileymat2 on Thursday January 27, 2022 @09:16AM (#30100811)
You also can’t tell what is supported behavior and what is implementation coincidence from the code…