2 ms·
"When everything fails, read the manual." --Anonymous? Add a few examples! I wish every new programming language posted here has an example section, like Hello
by gus_massa 1y ago
"When everything fails, read the manual." --Anonymous?
Add a few examples! I wish every new programming language posted here has an example section, like Hello Word and Fibonacci and 99 Bottles of Beer. Your project is not a programming language, so the examples should be different. But remember to add a few examples.
---
> for a technical audience who might just read the source anyway
"When everything fails again, read the source. -- Me, now
Many users will use your library without understanding the implementation details. It's a feature of a good library, so more people can use it.
And there are sometimes subtle details, like in "f(x, y)", can x and y be equal or y must be always greater than x. Perhaps it's easy to discover reading the source or perhaps the check is hidden after a few subroutine calls. Perhaps when x and y are equal f does nothing, and some libraries decide to check that and skip the situation and other to raise an error and other to make a huge mess.