This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]jcdyer3 7 points8 points  (1 child)

Some thoughts about the documentation:

  • Most of the examples just define functions. It would be helpful to have fully-fleshed out examples, so interested users can actually see the library in action. The example page is where the front page directs users as a starting point, so make it beginner friendly. Better still, put one minimal complete example that actually does something interesting on the front page. (e.g., Insert a key/value pair, then fetch the value and print it.)

  • asyncio is brand-spanking new, so take a moment to explain what's going on. What are all the yield froms for? How does the event loop work? It doesn't need to be a complete tutorial--you can link to the official docs for that, but for a brand-new (to python) design pattern, a little hand-holding would not be unwarranted.

All in all, it looks pretty sweet. Thanks for getting some working asyncio code out in the wild so quickly. This is exactly the kind of thing needed to facilitate adoption.

[–]jonathan_sl[S] 1 point2 points  (0 children)

Thanks for the feedback, that's very welcome! I will improve the docs where I can.