3 ms·
as a middle aged veteran i still get frustrated by the lack of intermediate-level examples in lib/framework documentation. even a link to a suitable github repo
by inconceivable 3y ago
as a middle aged veteran i still get frustrated by the lack of intermediate-level examples in lib/framework documentation. even a link to a suitable github repo showing a full usage of features would be useful. i can stare at the auto-generated API documentation or look at the source (or maybe even your test suite) for hours trying to hunt down features and flags and methods i can override and undocumented tricks i can use but why not just give people a useful example beyond hello world?
the best libs start with examples. here's a great one. it covered my entire use case in the first page of documentation.
https://tenacity.readthedocs.io/en/latest/ https://tenacity.readthedocs.io/en/latest/
like, how did you actually test this lib? surely you wrote something - anything - that uses some more of these features other than a test harness?
- duxup 3y agoYeah best practices / structure/ strategies beyond the basics are often a mystery.
- sheepybloke 3y agoThis was a huge frustration for me as I got into embedded programming. Once I got beyond the basics, it was incredibility hard to find information to take my engineering to the next level. For example, I was doing some work with ADCs and had a deep question about how to do the conversions properly for a sensor. Google kept taking me to site for beginners using Adafruit libraries or basic tutorials how to connect a sensor to an Arduino. There is so much information on helping people start now days, but not enough helping them get to becoming an intermediate developer.