search

capnproto / pycapnp

Cap'n Proto serialization/RPC system - Python bindings
BSD 2-Clause "Simplified" License
458 stars 125 forks source link

Update documentation to async code (#331) #332

Closed tobiasah closed 9 months ago

tobiasah commented 9 months ago

This commit updates the documentation to the latest changes added with pycapnp 2.0.0

tobiasah commented 9 months ago

~~This is just a draft and not finished yet. I just wanted to share the progress early in case someone wants to give feedback and avoid duplicate work.~~ I finished the essential adaption to the new changes. Let me know if something needs to be added or clarified. I would love to restructure and extend the documentation further in the future a bit more. But IMHO, for the 2.0.0, the current state is sufficient.

tobiasah commented 9 months ago

One thing that should be documented at some point is the ability to send and receive messages over a socket in async mode, like in this example: https://github.com/capnproto/pycapnp/blob/master/examples/async_socket_message_client.py

Right. I missed that. I added a small section for both the read-from and write-to a socket in the quickstart (https://github.com/capnproto/pycapnp/pull/332/commits/4fcf2b48cd7cfba348c24eb96c85d38dc5e75b0a). In general, I think the documentation could be improved with a better structure, but I first want to get out the beta before tackling that.