Al Sweigart on Nostr: Here's one thing I don't like about how software people write documentation: If A is ...
Here's one thing I don't like about how software people write documentation:
If A is a type of X and B is a type of X, there's a preference to separate X into its own definition elsewhere (like deduplicating code by putting it in a function). But this means the explanation of A or B is incomplete, because you have to click to learn what X is. If X is a type of Y, now you have to click again to figure out Y. You just wanted to learn what B was, but now you have to learn everything.
If A is a type of X and B is a type of X, there's a preference to separate X into its own definition elsewhere (like deduplicating code by putting it in a function). But this means the explanation of A or B is incomplete, because you have to click to learn what X is. If X is a type of Y, now you have to click again to figure out Y. You just wanted to learn what B was, but now you have to learn everything.