4 ms·
> We’ve probably all had the unpleasant experience of copying and pasting an example code snippet from someone’s documentation, and finding not only that it doe
by awinter-py 3y ago
> We’ve probably all had the unpleasant experience of copying and pasting an example code snippet from someone’s documentation, and finding not only that it doesn’t behave the way we expected, but that it doesn’t even compile. Not a good look for the project.
middle ground here is linting the examples if you can't make them interactive, but yes this is powerful
forever shocked by huge oss packages with seemingly lots of contributors and stars where the docs are simply wrong
corollary: if your framework cannot compile a working program from a single small file (looking at you xcode), this kind of 'here's a working example' documentation becomes much harder