3 ms·
> People will just copy-paste your example code. > People will not read the docs. Reminds me of a pull request I made a while ago https://github.com/krisajen
by alain_gilbert 4y ago
> People will just copy-paste your example code.
> People will not read the docs.
Reminds me of a pull request I made a while ago
https://github.com/krisajenkins/yesql/pull/151/files https://github.com/krisajenkins/yesql/pull/151/files
The first piece of code on the readme is "not the solution" (lol), and everybody I knew who was trying to use that library was copy-pasting that specific piece of code from the readme.
- parasti 4y agoThat's another thing not to do when writing a library: including and discussing code examples of incorrect usage. Personally, when I read documentation, retaining incorrect code examples is literally the last thing I want to achieve.